Skip to content
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

Toggle Switch, Checkbox, Radio Group - adjust component documentation #1071

Open
1 of 3 tasks
thrbnhrtmnn opened this issue Apr 5, 2024 · 0 comments
Open
1 of 3 tasks
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers 🎓 junior issue Good for juniors

Comments

@thrbnhrtmnn
Copy link
Contributor

thrbnhrtmnn commented Apr 5, 2024

Description / User story

The "ariaLabel" prop is not placed correctly in the props panel of the Toggle Switch, it should be placed in the section "Accessibility" right after the "States" section. Also the prop has the following description: "Provides additional information about the elements purpose and functionality to assistive technologies, such as screen readers."

The "indeterminatedIcon" prop has been renamed to "indeterminateIcon" for the Checkbox (also in the props panel).

The "legend" prop in the Radio Group should only be displayed in the prop pannel if hasLegend=true.
The errorMessage and the errorMessageIcon should be renamed to "groupErrorMessage" and "groupErrorIcon" in the Radio Groups prop panel.
In the Form Caption Group example story in the Radio Group Storybook documentation, the error message icon is missing (should be blrErrorFilled).

Requirements / Prerequisites

  • none

Acceptance Criteria

  • Acceptance Criteria 1
  • ...

Additional information

  • ...

Code of Conduct

  • I agree to follow this project's Code of Conduct
@thrbnhrtmnn thrbnhrtmnn added 🎓 junior issue Good for juniors ⌨️ dev issue Task is for developers ⭕ core team issue This is for the core team and should not be done by contributors labels Apr 5, 2024
@thrbnhrtmnn thrbnhrtmnn changed the title Toggle Switch, Checkbox - adjust component documentation Toggle Switch, Checkbox, Radio Group - adjust component documentation Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers 🎓 junior issue Good for juniors
Projects
None yet
Development

No branches or pull requests

1 participant