docs: document Suggester on the Input widget#6656
Open
youdie006 wants to merge 1 commit into
Open
Conversation
Add a Suggestions section to the Input widget docs with a runnable SuggestFromList example and a note on custom Suggester subclasses.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #4934.
Documents the
Suggesterfeature on the Input widget page, which had no coverage in the widget guide (only an API-page link).docs/widgets/input.mdwith a runnableSuggestFromListexample (thesuggester=parameter, accept-with-Right-at-cursor-end,case_sensitive) and a note on customSuggestersubclasses.docs/examples/widgets/input_suggestions.pymatching the sibling example convention.Grounded in
src/textual/suggester.pyandsrc/textual/widgets/_input.py. Credit to @dnlzrgz for proposing a candidateSuggestFromListexample in the thread.AI disclosure: this PR was drafted with Claude Code (AI-assisted); the example runs against the real API (
SuggestFromListresolves as documented).