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

chore: Update Switch docs #1527

Merged
merged 3 commits into from
Aug 24, 2024
Merged

Conversation

alimpens
Copy link
Contributor

@alimpens alimpens commented Aug 21, 2024

Describe the pull request

Thank you for contributing to the project!
Please use this template to help us handle your PR smoothly.

What

It updates our guidelines for the Switch component.

Why

We mentioned aria-label in the docs, which we advise against in other guidelines. The docs distinguished between a 'standalone' element and a form control, which is a little odd. Switch should always have a label I think, whether it's used in a form or not.

How

By removing references to aria-label and 'standalone component'.

Checklist

Before submitting your pull request, please ensure you have done the following. Check each checkmark if you have done so or if it wasn't necessary:

  • Add or update unit tests
  • Add or update documentation
  • Add or update stories
  • Add or update exports in index.* files
  • Start the PR title with a Conventional Commit prefix, as explained here.

Additional notes

  • Provide links to any related issues or discussions.
  • Add a link to the specific story in the feature branch deploy.
  • Mention any areas where additional review or feedback is needed.

@github-actions github-actions bot temporarily deployed to demo-DES-924-update-switch-docs August 24, 2024 07:42 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-924-update-switch-docs August 24, 2024 07:44 Destroyed
Copy link
Contributor

@VincentSmedinga VincentSmedinga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not convinced that a Switch should be used in a Form at all, but removing mentions of aria-label warrants merging the PR.

I’ve applied the rewording of the ‘interactive elements’ link in other places too.

@VincentSmedinga VincentSmedinga merged commit 274a916 into develop Aug 24, 2024
6 checks passed
@VincentSmedinga VincentSmedinga deleted the task/DES-924-update-switch-docs branch August 24, 2024 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants