Skip to content

Update Input widget documentation #5961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 20, 2025
Merged

Update Input widget documentation #5961

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c5dbc3
Added Input.Blurred to Input widget documentation
edward-jazzhands Jul 14, 2025
2c5fd5a
Also updated explanation in the "Validating Input" section
edward-jazzhands Jul 14, 2025
bd00e85
Changed message order to alphabetical
edward-jazzhands Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/widgets/input.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@ input = Input(validate_on=["submitted"])

Validation is considered to have failed if *any* of the validators fail.

You can check whether the validation succeeded or failed inside an [Input.Changed][textual.widgets.Input.Changed] or
[Input.Submitted][textual.widgets.Input.Submitted] handler by looking at the `validation_result` attribute on these events.
You can check whether the validation succeeded or failed inside an [Input.Changed][textual.widgets.Input.Changed], [Input.Submitted][textual.widgets.Input.Submitted], or [Input.Blurred][textual.widgets.Input.Blurred] handler by looking at the `validation_result` attribute on these events.

In the example below, we show how to combine multiple validators and update the UI to tell the user
why validation failed.
Expand Down Expand Up @@ -134,6 +133,7 @@ If you set `valid_empty=True` then empty values will bypass any validators, and

- [Input.Changed][textual.widgets.Input.Changed]
- [Input.Submitted][textual.widgets.Input.Submitted]
- [Input.Blurred][textual.widgets.Input.Blurred]

## Bindings

Expand Down