Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darrenburns/textual-autocomplete
Easily add autocomplete dropdowns to your Textual apps
https://github.com/darrenburns/textual-autocomplete
autocomplete dropdown library python terminal textual tui
Last synced: about 1 month ago
JSON representation
Easily add autocomplete dropdowns to your Textual apps
- Host: GitHub
- URL: https://github.com/darrenburns/textual-autocomplete
- Owner: darrenburns
- License: mit
- Created: 2022-11-22T16:49:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T02:00:52.000Z (7 months ago)
- Last Synced: 2024-04-16T03:57:47.149Z (5 months ago)
- Topics: autocomplete, dropdown, library, python, terminal, textual, tui
- Language: Python
- Homepage:
- Size: 227 KB
- Stars: 132
- Watchers: 2
- Forks: 13
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-textualize-projects - Autocomplete - Easily add autocomplete dropdowns to your Textual apps. (Community / Third Party Applications)
README
# textual-autocomplete
textual-autocomplete is a Python library for creating dropdown autocompletion menus in
Textual applications, allowing users to quickly select from a list of suggestions as
they type. *textual-autocomplete supports **Textual version 0.14.0** and above.*
Video example
https://user-images.githubusercontent.com/5740731/205718330-a9364894-9133-40ca-8249-6e3dcc13f456.mov
> [!WARNING]
> This README is relevant to version 2.x of `textual-autocomplete`. Alpha versions of version 3 are available on PyPI now, but they are unstable and undocumented.
> For best results, pin `textual-autocomplete` to version 2.
## Quickstart
Simply wrap a Textual `Input` widget as follows:
```python
from textual.app import ComposeResult
from textual.widgets import Input
from textual_autocomplete import AutoComplete, Dropdown, DropdownItem
def compose(self) -> ComposeResult:
yield AutoComplete(
Input(placeholder="Type to search..."),
Dropdown(items=[
DropdownItem("Glasgow"),
DropdownItem("Edinburgh"),
DropdownItem("Aberdeen"),
DropdownItem("Dundee"),
]),
)
```
There are more complete examples [here](./examples).
## Installation
`textual-autocomplete` can be installed from PyPI using your favourite dependency
manager.
## Usage
### Wrapping your `Input`
As shown in the quickstart, you can wrap the Textual builtin `Input` widget with
`AutoComplete`, and supply a `Dropdown`.
The `AutoComplete` manages communication between the `Input` and the `Dropdown`.
The `Dropdown` is the widget you see on screen, as you type into the input.
The `DropdownItem`s contain up to 3 columns. All must contain a "main" column, which
is the central column used in the filtering. They can also optionally contain a left and right metadata
column.
### Supplying data to `Dropdown`
You can supply the data for the dropdown via a list or a callback function.
#### Using a list
The easiest way to use textual-autocomplete is to pass in a list of `DropdownItem`s,
as shown in the quickstart.
#### Using a callable
Instead of passing a list of `DropdownItems`, you can supply a callback function
which will be called with the current input state. From this function, you should
return the list of `DropdownItems` you wish to be displayed.
See [here](./examples/custom_meta.py) for a usage example.
### Keyboard control
- Press the Up/Down arrow keys to navigate.
- Press Enter to select the item in the dropdown and fill it in.
- Press Tab to fill in the selected item, and move focus.
- Press Esc to hide the dropdown.
- Press the Up/Down arrow keys to force the dropdown to appear.
### Styling
The `Dropdown` itself can be styled using Textual CSS.
For more fine-grained control over styling, you can target the following CSS classes:
- `.autocomplete--highlight-match`: the highlighted portion of a matching item
- `.autocomplete--selection-cursor`: the item the selection cursor is on
- `.autocomplete--left-column`: the left metadata column, if it exists
- `.autocomplete--right-column`: the right metadata column, if it exists
Since the 3 columns in `DropdownItem` support Rich `Text` objects, they can be styled dynamically.
The [custom_meta.py](./examples/custom_meta.py) file is an example of this, showing how the rightmost column is coloured dynamically based on the city population.
The [examples directory](./examples) contains multiple examples of custom styling.
### Messages
When you select an item in the dropdown, an `AutoComplete.Selected` event is emitted.
You can declare a handler for this event `on_auto_complete_selected(self, event)` to respond
to an item being selected.
An item is selected when it's highlighted in the dropdown, and you press Enter or Tab.
Pressing Enter simply fills the value in the dropdown, whilst Tab fills the value
and then shifts focus from the input.
## Other notes
- textual-autocomplete will create a new layer at runtime on the `Screen` that the `AutoComplete` is on. The `Dropdown` will be rendered on this layer.
- The position of the dropdown is currently fixed _below_ the value entered into the `Input`. This means if your `Input` is at the bottom of the screen, it's probably not going to be much use for now. I'm happy to discuss or look at PRs that offer a flag for having it float above.
- There's currently no special handling for when the dropdown meets the right-hand side of the screen.
- Do not apply `margin` to the `Dropdown`. The position of the dropdown is updated by applying margin to the top/left of it.
- There's currently no debouncing support, but I'm happy to discuss or look at PRs for this.
- There are a few known issues/TODOs in the code, which will later be transferred to GitHub.
- Test coverage is currently non-existent - sorry!