Update Input widget documentation #5961
Open
Conversation
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
willmcgugan
requested changes
Jul 17, 2025
docs/widgets/input.md
Outdated
| @@ -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] | |||
There was a problem hiding this comment.
Can we have this in alphabetical order please.
| @@ -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. | |||
|
Docs have been deployed since you wrote this, I see the new Message: https://textual.textualize.io/widgets/input/#textual.widgets.Input.Blurred |
|
order has been fixed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Please review the following checklist.
I realized that the Input widget documentation needed to be updated for a previous PR I made, which added the
Blurredmessage to the Input widget. My apologies, I was newer to this at the time and didn't realize I should have updated that at the same time. This PR updates the Input widget reference page in the two places whereInput.ChangedandInput.Submittedare mentioned.Also I see that the technical class reference section seems to be auto generated. The Input.Blurred message is not in the current version so I'm guessing it needs to be regenerated? I'm not sure if you need me to do anything for that.