Add auto_focus to screens
#2527
Merged
Conversation
This file contains 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
May 9, 2023
src/textual/screen.py
Outdated
| @@ -101,6 +101,12 @@ class Screen(Generic[ScreenResultType], Widget): | |||
| } | |||
| """ | |||
|
|
|||
| auto_focus: str | None = "*" | |||
There was a problem hiding this comment.
Let's make this an instance var, which should be the default unless there is good rationale for it being a classvar.
There was a problem hiding this comment.
Mostly because it's a pain to set it as an instance attribute-only for people creating their own screens:
class FormScreen(Screen):
auto_focus = "Input"
...vs
class FormScreen(Screen):
def __init__(
self,
name: str | None = None,
id: str | None = None,
classes: str | None = None,
) -> None:
self.auto_focus = "Input"
super().__init__(name=name, id=id, classes=classes)
...There was a problem hiding this comment.
If we want it to be a classvar, suggest we make it a constant, i.e. AUTO_FOCUS.
There was a problem hiding this comment.
Classvar it is.
willmcgugan
approved these changes
May 14, 2023
davep
added a commit
to davep/textual
that referenced
this pull request
Jun 1, 2023
See Textualize#2718. The problem is that the work done on Textualize#2527 and related PRs has changed the starting position of focus, which means that any code example that has key presses in them that start out by tabbing to a control will be off by one.
This was referenced Jun 1, 2023
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.
This will close #2457.
I've added a docstring but I haven't added documentation elsewhere. Should I?