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

Update TextField documentation to remove the necessity of a label #1066

Closed
Nickzlos opened this issue Dec 11, 2024 · 1 comment
Closed

Update TextField documentation to remove the necessity of a label #1066

Nickzlos opened this issue Dec 11, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Nickzlos
Copy link
Member

TL;DR: We have updated the guidelines for using labels with the TextField component. A label is no longer strictly mandatory in all cases.

Reason for the Update

  • Contextual Understanding: In some scenarios, the input requirements for a TextField can be inferred from the surrounding context. In such cases, an aria-label or aria-labelledby attribute may suffice, and a dedicated label can be omitted.
  • Unintended Consequences: The strict requirement for TextField labels led some users to assume that a label is necessary for other form control components (e.g., SegmentedControl).

Benefits

  • Labels are still encouraged where they improve clarity, but this new flexibility allows for cleaner designs.
  • By removing unnecessary labels, we can make more space-efficient designs and reduce excessive whitespace in certain layouts.
  • We ensure a cohesive label usage within all form controls and deliver greater clarity in when and how to use labels
@Nickzlos Nickzlos added the documentation Improvements or additions to documentation label Dec 11, 2024
@Nickzlos Nickzlos self-assigned this Dec 11, 2024
@Nickzlos
Copy link
Member Author

Closed with the to changes within

#1060
#1061
#1062
#1063
#1065

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant