Autocomplete Providers

Data providers for autocomplete in Input and CommandPalette

Quick Start

main.py

from connectonion.tui import Input, FileProvider, StaticProvider

# File autocomplete
text = Input(triggers={"@": FileProvider()}).run()

# Command autocomplete
commands = StaticProvider([
    ("/today", "/today", "Daily briefing"),
    ("/inbox", "/inbox", "Show emails"),
])
text = Input(triggers={"/": commands}).run()

StaticProvider

Provider for static list of items:

Simple (display, value)

main.py

from connectonion.tui import StaticProvider

provider = StaticProvider([
    ("/today", "/today"),
    ("/inbox", "/inbox"),
])

With Descriptions

main.py

provider = StaticProvider([
    ("/today", "/today", "Daily email briefing"),
    ("/inbox", "/inbox", "Show recent emails"),
])

With Icons

main.py

provider = StaticProvider([
    ("/today", "/today", "Daily briefing", "📅"),
    ("/inbox", "/inbox", "Show emails", "📥"),
])

FileProvider

Provider for filesystem autocomplete:

main.py

from connectonion.tui import FileProvider

# Default: current directory
provider = FileProvider()

# Custom root
provider = FileProvider(root="src/")

# Results include:
# - Folders with 📁 icon
# - Files with type-specific icons
# - Fuzzy matched against query

Custom Provider

Implement the Provider protocol:

main.py

from connectonion.tui import DropdownItem

class MyProvider:
    def search(self, query: str) -> list[DropdownItem]:
        # Return matching items
        return [
            DropdownItem(display="Result", value="result"),
        ]

Provider Protocol

main.py

class Provider(Protocol):
    def search(self, query: str) -> list[DropdownItem]:
        ...

Returns list of DropdownItem or tuples (display, value, score, positions).

Built-in Providers

FileProvider

Browse filesystem with type-specific icons

StaticProvider

Static list of options with optional metadata

Input

Text input with trigger-based autocomplete

Dropdown

The dropdown component that displays results

Keyboard Input

Interactive Debugging

Autocomplete Providers

Quick Start

StaticProvider

Simple (display, value)

With Descriptions

With Icons

FileProvider

Custom Provider

Provider Protocol

Built-in Providers

FileProvider

StaticProvider

Related