-
Notifications
You must be signed in to change notification settings - Fork 943
origin/radio_button_vika #1412
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.
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
base: main
Are you sure you want to change the base?
origin/radio_button_vika #1412
Conversation
Replaced old radio button images with updated versions, adding light and dark mode variants for clarity and consistency. Older assets were moved to a dedicated "old" folder for archival purposes. This improves structure and supports a more modern visual design.
Updated phrasing to improve clarity and consistency, emphasizing when to use checkboxes for two opposing choices. No functional or structural changes were made.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review is complete, thanks for the updated topic!
topics/ui/controls/radio_button.md
Outdated
@@ -89,19 +107,22 @@ Use the imperative form of verbs. | |||
|
|||
Do not use negation in labels as it complicates understanding. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Possibly add examples for each rule here with correct incorrect usages to help people better understand the rules
- Add bullets to the bullet list
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't be a bullet list according to how we write articles now. See how the same section is structured in the Button article
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think if I add all the wrong things in one image? I think it’s quite possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like one pic. Possibly two pics could be shown side by side?
Also, I see I wrote about a bullet list — scratch that, please make a bullet list, Marianna made it in https://plugins.jetbrains.com/docs/intellij/inline-help-text.html#writing_guidelines, looks fine.
topics/ui/controls/radio_button.md
Outdated
@@ -89,19 +107,22 @@ Use the imperative form of verbs. | |||
|
|||
Do not use negation in labels as it complicates understanding. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't be a bullet list according to how we write articles now. See how the same section is structured in the Button article
Refined documentation for radio button usage, including adjustments to labels, option grouping, and alternative UI recommendations. Updated associated images for consistency. Modified Kotlin and Gradle configurations in project settings.
Updated the recommended number of options for radio buttons and cleaned up examples in the dropdown section. Refactored implementation code examples using collapsible chapters for better readability in rendered documentation.
Removed redundant image table and streamlined text for clarity. Added updated images to improve guidance on correct and incorrect labeling practices. Ensured consistent formatting across the documentation.
Added clear formatting tags to emphasize correct and incorrect examples in the documentation. This enhances readability and helps users quickly differentiate between correct and incorrect usage.
Refined the "How to use" images to align with updated UI elements. Ensures consistency and clarity for both light and dark theme presentations.
topics/ui/controls/radio_button.md
Outdated
|
||
Or, if the options can be represented on an axis, such as a time delay, use a slider. | ||
|
||
### When to Use a Dropdown Instead of Radio Buttons |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use sentence case for the header. Also "drop-down"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn’t come up with a subtitle that forms a sentence with the title “When not to use,” so I suggest giving it its own title. WDYT?
|
||
Or, if the options can be represented on an axis, such as a time delay, use a slider. | ||
|
||
### When to Use a Dropdown Instead of Radio Buttons | ||
Consider using a [drop-down list](drop_down.md) if: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A verb is missing here, the introductory sentence and bullet points should form a complete sentence
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added the verb to the sentences in the list where it was missing
topics/ui/controls/radio_button.md
Outdated
Consider using a [drop-down list](drop_down.md) if: | ||
* 5 options with long lables | ||
* More then 5 options |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These 2 rules seem a bit more complex than needed — need to keep in mind all the number of options we allow for the radio and segmented control. Possibly just write something like "There are 5 and more options, especially if they have long labels"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Options with long labels won’t look good regardless of how many there are, so I suggest using radio buttons in that case. WDYT?
topics/ui/controls/radio_button.md
Outdated
@@ -89,19 +107,22 @@ Use the imperative form of verbs. | |||
|
|||
Do not use negation in labels as it complicates understanding. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like one pic. Possibly two pics could be shown side by side?
Also, I see I wrote about a bullet list — scratch that, please make a bullet list, Marianna made it in https://plugins.jetbrains.com/docs/intellij/inline-help-text.html#writing_guidelines, looks fine.
Streamlined dropdown section for clarity, reorganized writing guidelines into bullet points, and updated references to layout rules. Added new images for light and dark themes to enhance visual guidance.
No description provided.