docs(menu-toggle): Adds docs for split button examples. #10268
Conversation
|
Preview: https://patternfly-react-pr-10268.surge.sh A11y report: https://patternfly-react-pr-10268-a11y.surge.sh |
|
@thatblindgeye lmk what you think about my initial edits / if I'm off the mark on things! |
|
|
||
| ``` | ||
|
|
||
| ### Split button toggle with checkbox and toggle button text | ||
| ### Split button toggle with checkbox and clickable text label |
There was a problem hiding this comment.
Maybe Split button toggle with a labelled checkbox? "clickable text label" makes me think of the clickable toggle text use case more than the onChange-triggering use case (and could be moved to line 210 for that example, but just having "text label" alone is also fine with me for that).
There was a problem hiding this comment.
The "...with labelled checkbox" could work. Maybe the other example name could be tweaked to "...with checkbox and toggle text label"? @edonehoo wdyt?
There was a problem hiding this comment.
I really like "a labelled checkbox"!
For the "clickable" example - I was trying to find a way to make things more concise/short and avoid writing "toggle" multiple times in the heading, but definitely want to be precise
- Is "split button toggle with checkbox label that toggles" accurate? If not, I can go with Eric's suggestion instead!
There was a problem hiding this comment.
Yeah having to repeat the "Split button toggle" text makes things difficult here 😆 Could "checkbox label that toggles" imply that the text is toggling the checkbox?
Do you think updating the examples to "Split toggle..." rather than "Split button toggle..." would help at all? I feel like ideally it'd be great to have a separate examples section for "Split button toggle examples" then the example titles could just omit the "Split button toggle" part, but I feel like there's still the issue with how our examples are rendered in Org that would cause some issue with that.
There was a problem hiding this comment.
"a separate examples section for "Split button toggle examples"" is exactly what I was wishing we could do 😭 but yeah I remember there being org restrictions around that
I like the idea of going with "split toggle". It's a small change, but it'll help cut down on wordiness, while still getting the point across!
I went with your previous selection "Split toggle with checkbox and toggle text label" & updated the other example headings in my last commit. I think I'm still having my own comprehension issues with these examples that get in the way of my suggestions lol - so as long as what we have makes sense from a dev standpoint I'm happy!
There was a problem hiding this comment.
To be fair the examples are very similar, so I definitely get any confusion or anything with them! Thanks for making these updates 🪨 ⭐
Closes #10258