Rename Checkbox to Switch
#1751
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
A new form of Checkbox will be arriving in Textual soon, working in conjunction with a RadioButton. What was called Checkbox is perhaps a wee bit heavyweight in terms of visual design, but is a style of widget that should remain. With this in mind we're renaming the current Checkbox to Switch. In all other respects its workings remains the same, only the name has changed. Things for people to watch out for: - Imports will need to be updated. - Queries will need to be updated; special attention will need to be paid to any queries that are string-based. - CSS will need to be changed if any Checkbox styling is happening, or if any Checkbox component styles are being used. See Textualize#1725 as the initial motivation and Textualize#1746 as the issue for this particular change.
|
Consideration will need to be given to this PR and the work that @rodrigogiraoserrao is doing on documenting compound widgets as his example application does make use of |
|
Consider my work independent of this PR. We can merge this and I'll update my examples accordingly. |
rodrigogiraoserrao
previously requested changes
Feb 9, 2023
willmcgugan
approved these changes
Feb 9, 2023
davep
dismissed stale reviews from darrenburns and rodrigogiraoserrao
Testing dismissing a review (because we weren't sure if it would let you say why or not).
davep
added a commit
to davep/textual
that referenced
this pull request
Feb 9, 2023
Following on from Textualize#1751: originally Switch was called Checkbox and the moving part was, for the component class, called a checkbox--switch; after renaming the widget to Switch that component class ended up being switch--switch; which wasn't ideal. We decided to go with it as-is, but I just realised that internally the code calls it a slider. So this leans into that and I'm renaming the component class switch--slider. This removes the doubling-up of the name and also makes the code more consistent.
Merged
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.
A new form of Checkbox will be arriving in Textual soon, working in conjunction with a RadioButton. What was called Checkbox is perhaps a wee bit heavyweight in terms of visual design, but is a style of widget that should remain.
With this in mind we're renaming the current Checkbox to Switch. In all other respects its workings remains the same, only the name has changed.
Things for people to watch out for:
See #1725 as the initial motivation and #1746 as the issue for this particular change.