Renaming, fixing propagation

Author: darrenburns

README.md

@@ -21,7 +21,7 @@ Here's the simplest possible way to add autocomplete to your Textual app:
 ```python
 from textual.app import App, ComposeResult
 from textual.widgets import Input
-from textual_autocomplete import InputAutoComplete, DropdownItem
+from textual_autocomplete import AutoComplete, DropdownItem
 
 class ColorFinder(App):
     def compose(self) -> ComposeResult:
@@ -30,7 +30,7 @@ class ColorFinder(App):
         yield text_input
 
         # Add an autocomplete to the same screen, and pass in the input widget.
-        yield InputAutoComplete(
+        yield AutoComplete(
             text_input,  # Target input widget
             candidates=["Red", "Green", "Blue", "Yellow", "Purple", "Orange"]
         )
@@ -59,7 +59,7 @@ These columns are display-only, and do not influence the search process.
 ```python
 from textual.app import App, ComposeResult
 from textual.widgets import Input
-from textual_autocomplete import InputAutoComplete, DropdownItem
+from textual_autocomplete import AutoComplete, DropdownItem
 
 # Create dropdown items with a left metadata column.
 ITEMS = [
@@ -73,7 +73,7 @@ class LanguageSearcher(App):
     def compose(self) -> ComposeResult:
         text_input = Input(placeholder="Programming language...")
         yield text_input
-        yield InputAutoComplete(text_input, candidates=ITEMS)
+        yield AutoComplete(text_input, candidates=ITEMS)
 
 if __name__ == "__main__":
     app = LanguageSearcher()
@@ -88,7 +88,7 @@ Add rich styling to your metadata columns using [Textual markup](https://textual
 from textual.app import App, ComposeResult
 from textual.content import Content
 from textual.widgets import Input, Label
-from textual_autocomplete import InputAutoComplete, DropdownItem
+from textual_autocomplete import AutoComplete, DropdownItem
 
 # Languages with their popularity rank
 LANGUAGES_WITH_RANK = [
@@ -118,7 +118,7 @@ class LanguageSearcher(App):
         yield Label("Start typing a programming language:")
         text_input = Input(placeholder="Type here...")
         yield text_input
-        yield InputAutoComplete(target=text_input, candidates=CANDIDATES)
+        yield AutoComplete(target=text_input, candidates=CANDIDATES)
 
 if __name__ == "__main__":
     app = LanguageSearcher()
@@ -137,7 +137,7 @@ if __name__ == "__main__":
 The dropdown can be styled using Textual CSS:
 
 ```css
-    InputAutoComplete {
+    AutoComplete {
         /* Customize the dropdown */
         & AutoCompleteList {
             max-height: 6;  /* The number of lines before scrollbars appear */
@@ -185,21 +185,21 @@ DropdownItem(
 
 ## Completing Paths
 
-`textual-autocomplete` includes a `PathInputAutoComplete` widget that can be used to autocomplete filesystem paths.
+`textual-autocomplete` includes a `PathAutoComplete` widget that can be used to autocomplete filesystem paths.
 
 ```python
 from textual.app import App, ComposeResult
 from textual.containers import Container
 from textual.widgets import Button, Input, Label
 
-from textual_autocomplete import PathInputAutoComplete
+from textual_autocomplete import PathAutoComplete
 
 class FileSystemPathCompletions(App[None]):
     def compose(self) -> ComposeResult:
         yield Label("Choose a file!", id="label")
         input_widget = Input(placeholder="Enter a path...")
         yield input_widget
-        yield PathInputAutoComplete(target=input_widget, path="../textual")
+        yield PathAutoComplete(target=input_widget, path="../textual")
 
 
 if __name__ == "__main__":
@@ -211,7 +211,7 @@ Here's what that looks like in action:
 
 https://github.com/user-attachments/assets/25b80e34-0a35-4962-9024-f2dab7666689
 
-`PathInputAutoComplete` has a bunch of parameters that can be used to customize the behavior - check the docstring for more details. It'll also cache directory contents after reading them once - but you can clear the cache if you need to using the `clear_directory_cache` method.
+`PathAutoComplete` has a bunch of parameters that can be used to customize the behavior - check the docstring for more details. It'll also cache directory contents after reading them once - but you can clear the cache if you need to using the `clear_directory_cache` method.
 
 ## Dynamic Data with Callbacks
 
@@ -225,15 +225,15 @@ The app below displays the length of the text in the input widget in the prefix
 from textual.app import App, ComposeResult
 from textual.widgets import Input
 
-from textual_autocomplete import InputAutoComplete
+from textual_autocomplete import AutoComplete
 from textual_autocomplete._autocomplete import DropdownItem, TargetState
 
 
 class DynamicDataApp(App[None]):
     def compose(self) -> ComposeResult:
         input_widget = Input()
         yield input_widget
-        yield InputAutoComplete(input_widget, candidates=self.candidates_callback)
+        yield AutoComplete(input_widget, candidates=self.candidates_callback)
 
     def candidates_callback(self, state: TargetState) -> list[DropdownItem]:
         left = len(state.text)
@@ -262,13 +262,13 @@ Notice the count displayed in the prefix increment and decrement based on the ch
 
 ## Customizing Behavior
 
-If you need custom behavior, `InputAutoComplete` is can be subclassed.
+If you need custom behavior, `AutoComplete` is can be subclassed.
 
-A good example of how to subclass and customize behavior is the `PathInputAutoComplete` widget, which is a subclass of `InputAutoComplete`.
+A good example of how to subclass and customize behavior is the `PathAutoComplete` widget, which is a subclass of `AutoComplete`.
 
 Some methods you may want to be aware of which you can override:
 
-- `get_candidates`: Return a list of `DropdownItem` objects - called each time the input changes or the cursor position changes. Note that if you're overriding this in a subclass, you'll need to make sure that the `get_candidates` parameter passed into the `InputAutoComplete` constructor is set to `None` - this tells `textual-autocomplete` to use the subclassed method instead of the default.
+- `get_candidates`: Return a list of `DropdownItem` objects - called each time the input changes or the cursor position changes. Note that if you're overriding this in a subclass, you'll need to make sure that the `get_candidates` parameter passed into the `AutoComplete` constructor is set to `None` - this tells `textual-autocomplete` to use the subclassed method instead of the default.
 - `get_search_string`: The string that will be used to filter the candidates. You may wish to only use a portion of the input text to filter the candidates rather than the entire text.
 - `apply_completion`: Apply the completion to the target input widget. Receives the value the user selected from the dropdown and updates the `Input` directly using it's API.
 - `post_completion`: Called when a completion is selected. Called immediately after `apply_completion`. The default behaviour is just to hide the completion dropdown (after performing a completion, we want to immediately hide the dropdown in the default case).

examples/basic_single_column.py

@@ -3,7 +3,7 @@
 from textual.app import App, ComposeResult
 from textual.widgets import Input
 
-from textual_autocomplete import InputAutoComplete
+from textual_autocomplete import AutoComplete
 
 LANGUAGES = [
     "Python",
@@ -22,7 +22,7 @@ def compose(self) -> ComposeResult:
         text_input = Input(placeholder="Search for a programming language...")
         yield text_input
 
-        yield InputAutoComplete(
+        yield AutoComplete(
             target=text_input,  # The widget to attach autocomplete to
             candidates=LANGUAGES,  # The list of completion candidates
         )

examples/basic_two_column.py

@@ -4,7 +4,7 @@
 from textual.content import Content
 from textual.widgets import Input, Label
 
-from textual_autocomplete import InputAutoComplete, DropdownItem
+from textual_autocomplete import AutoComplete, DropdownItem
 
 # Languages with their popularity rank
 LANGUAGES_WITH_RANK = [
@@ -36,7 +36,7 @@ def compose(self) -> ComposeResult:
         text_input = Input(placeholder="Type here...")
         yield text_input
 
-        yield InputAutoComplete(
+        yield AutoComplete(
             target=text_input,  # The widget to attach autocomplete to
             candidates=CANDIDATES,  # The list of completion candidates
         )

examples/basic_two_column_heavy_styles.py

@@ -4,7 +4,7 @@
 from textual.content import Content
 from textual.widgets import Input, Label
 
-from textual_autocomplete import InputAutoComplete, DropdownItem
+from textual_autocomplete import AutoComplete, DropdownItem
 from examples._headers import headers
 
 # Define a mapping of sections to colors
@@ -44,7 +44,7 @@ def compose(self) -> ComposeResult:
         text_input = Input(placeholder="Type here...")
         yield text_input
 
-        yield InputAutoComplete(
+        yield AutoComplete(
             target=text_input,  # The widget to attach autocomplete to
             candidates=CANDIDATES,  # The list of completion candidates
         )

examples/dynamic_data.py

@@ -1,7 +1,7 @@
 from textual.app import App, ComposeResult
 from textual.widgets import Input
 
-from textual_autocomplete import InputAutoComplete
+from textual_autocomplete import AutoComplete
 from textual_autocomplete._autocomplete import DropdownItem, TargetState
 
 
@@ -15,7 +15,7 @@ class DynamicDataApp(App[None]):
     def compose(self) -> ComposeResult:
         input_widget = Input()
         yield input_widget
-        yield InputAutoComplete(input_widget, candidates=self.get_candidates)
+        yield AutoComplete(input_widget, candidates=self.get_candidates)
 
     def get_candidates(self, state: TargetState) -> list[DropdownItem]:
         left = len(state.text)

examples/left_column_styling.py

@@ -2,7 +2,7 @@
 from textual.content import Content
 from textual.widgets import Input
 
-from textual_autocomplete import InputAutoComplete, DropdownItem
+from textual_autocomplete import AutoComplete, DropdownItem
 
 
 LANGUAGES = [
@@ -14,9 +14,7 @@
         "Golang",
         prefix=Content.from_markup("[$text-primary on $primary-muted] 🔷 "),
     ),
-    DropdownItem(
-        "Java", prefix=Content.from_markup("[#6a2db5 on magenta 20%] ☕ ")
-    ),
+    DropdownItem("Java", prefix=Content.from_markup("[#6a2db5 on magenta 20%] ☕ ")),
     DropdownItem(
         "Rust", prefix=Content.from_markup("[$text-accent on $accent-muted] 🦀 ")
     ),
@@ -33,7 +31,7 @@ class LanguagesSearchApp(App[None]):
     def compose(self) -> ComposeResult:
         input_widget = Input(placeholder="Search for a programming language...")
         yield input_widget
-        yield InputAutoComplete(target=input_widget, candidates=LANGUAGES)
+        yield AutoComplete(target=input_widget, candidates=LANGUAGES)
 
 
 if __name__ == "__main__":

examples/partial_completions.py

@@ -13,7 +13,7 @@
 from textual.containers import Container
 from textual.widgets import Button, Input, Label
 
-from textual_autocomplete import PathInputAutoComplete
+from textual_autocomplete import PathAutoComplete
 
 
 class FileSystemPathCompletions(App[None]):
@@ -35,7 +35,7 @@ def compose(self) -> ComposeResult:
             yield Label("Choose a file!", id="label")
             input_widget = Input(placeholder="Enter a path...")
             yield input_widget
-        yield PathInputAutoComplete(target=input_widget, path="../textual")
+        yield PathAutoComplete(target=input_widget, path="../textual")
         yield Button("Go")
 
 

tests/snapshots/test_cursor_tracking.py

@@ -2,7 +2,7 @@
 from textual.containers import Center, VerticalScroll
 from textual.pilot import Pilot
 from textual.widgets import Input
-from textual_autocomplete import InputAutoComplete
+from textual_autocomplete import AutoComplete
 
 
 class CursorTracking(App[None]):
@@ -27,7 +27,7 @@ def compose(self) -> ComposeResult:
             with Center():
                 yield (input := Input(placeholder="Type here..."))
 
-        yield InputAutoComplete(
+        yield AutoComplete(
             target=input,
             candidates=["foo", "bar", "baz", "qux", "boop"],
         )

tests/snapshots/test_input.py

@@ -5,7 +5,7 @@
 from textual.widgets import Input
 from textual.widgets.input import Selection
 
-from textual_autocomplete import InputAutoComplete, AutoCompleteList, DropdownItem
+from textual_autocomplete import AutoComplete, AutoCompleteList, DropdownItem
 
 LANGUAGES = [
     "Python",
@@ -28,7 +28,7 @@ class BasicInputAutocomplete(App[None]):
     def compose(self) -> ComposeResult:
         input = Input(placeholder="Type here...")
         yield input
-        yield InputAutoComplete(
+        yield AutoComplete(
             target=input,
             candidates=CANDIDATES,
         )
@@ -208,8 +208,8 @@ def test_multiple_autocomplete_dropdowns_on_a_single_input(snap_compare):
     class MultipleAutocompleteDropdowns(App[None]):
         def compose(self) -> ComposeResult:
             yield (input1 := Input(placeholder="Type here..."))
-            yield InputAutoComplete(target=input1, candidates=LANGUAGES)
-            yield InputAutoComplete(
+            yield AutoComplete(target=input1, candidates=LANGUAGES)
+            yield AutoComplete(
                 target=input1,
                 candidates=["foo", "bar", "java", "javas", "javassss", "jajaja"],
             )
@@ -229,10 +229,10 @@ class MultipleAutocompleteDropdowns(App[None]):
         def compose(self) -> ComposeResult:
             yield (input1 := Input(placeholder="Type here..."))
             # Setup with strings...
-            yield InputAutoComplete(target=input1, candidates=LANGUAGES)
+            yield AutoComplete(target=input1, candidates=LANGUAGES)
             yield (input2 := Input(placeholder="Also type here..."))
             # ...and with DropdownItems...
-            yield InputAutoComplete(target=input2, candidates=CANDIDATES)
+            yield AutoComplete(target=input2, candidates=CANDIDATES)
 
     async def run_before(pilot: Pilot[None]) -> None:
         await pilot.press("tab")

tests/snapshots/test_prevent_default.py

@@ -3,7 +3,7 @@
 from typing import Any
 from textual.app import App, ComposeResult
 from textual.widgets import Button, Input
-from textual_autocomplete import InputAutoComplete
+from textual_autocomplete import AutoComplete
 
 
 class PreventDefaultTab(App[None]):
@@ -18,7 +18,7 @@ def __init__(
     def compose(self) -> ComposeResult:
         input = Input(placeholder="Type something...")
         yield input
-        yield InputAutoComplete(
+        yield AutoComplete(
             input,
             candidates=["foo", "bar"],
             prevent_default_tab=self.prevent_default_tab,

tests/snapshots/test_styling.py

@@ -1,20 +1,20 @@
 from textual.app import App, ComposeResult
 from textual.pilot import Pilot
 from textual.widgets import Input
-from textual_autocomplete import InputAutoComplete
+from textual_autocomplete import AutoComplete
 
 
 class StyledAutocomplete(App[None]):
     def compose(self) -> ComposeResult:
         input = Input(placeholder="Search...")
         yield input
-        yield InputAutoComplete(target=input, candidates=["foo", "bar", "baz", "qux"])
+        yield AutoComplete(target=input, candidates=["foo", "bar", "baz", "qux"])
 
 
 def test_foreground_color_and_text_style(snap_compare):
     """Background color should not be impacted by the text foreground and style."""
     StyledAutocomplete.CSS = """
-    InputAutoComplete {
+    AutoComplete {
         & .autocomplete--highlight-match {
             color: $text-accent;
             text-style: bold italic underline;
@@ -30,7 +30,7 @@ async def run_before(pilot: Pilot) -> None:
 
 def test_background_color_and_removed_style(snap_compare):
     StyledAutocomplete.CSS = """
-    InputAutoComplete {
+    AutoComplete {
         & .autocomplete--highlight-match {
             color: $text-accent;
             background: $success-muted;
@@ -48,7 +48,7 @@ async def run_before(pilot: Pilot) -> None:
 def test_max_height_and_scrolling(snap_compare):
     """We should be scrolled to qux, and the red scrollbar should reflect that."""
     StyledAutocomplete.CSS = """
-    InputAutoComplete {
+    AutoComplete {
         & AutoCompleteList {
             scrollbar-color: red;
             max-height: 2;
@@ -65,7 +65,7 @@ async def run_before(pilot: Pilot) -> None:
 def test_dropdown_styles_match_textual_theme(snap_compare):
     """Dropdown styles should match the textual theme. In this test, we've swapped the theme to nord."""
     StyledAutocomplete.CSS = """
-    InputAutoComplete {
+    AutoComplete {
         & .autocomplete--highlight-match {
             color: $text-accent;
         }
@@ -82,7 +82,7 @@ async def run_before(pilot: Pilot) -> None:
 def test_cursor_color_change_and_dropdown_background_change(snap_compare):
     """Checking various interactions between styles. See the test's CSS for info."""
     StyledAutocomplete.CSS = """
-    InputAutoComplete {
+    AutoComplete {
 
         & AutoCompleteList {
             color: red;