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

Block documentation does not list allowed values for variant prop or explain aria-label use. #727

Open
danielck opened this issue May 17, 2023 · 0 comments

Comments

@danielck
Copy link
Contributor

The Problem

The Block component has a variant prop which only supports specific values ('default','div','span','section','header','nav','main','footer'). This is not communicated clearly in the prop documentation.

Also, e.g. <section> requires an aria-label to be interpreted as a landmark by many assistive technology, and nav elements should have aria-labels when there are multiple navigation blocks of differing type on the same page.

Proposed Solution

  • Rewrite the prop description of variant to explain that possible values are 'default','div','span','section','header','nav','main' and 'footer'.
  • Make it explicit that attributes like aria-label, aria-labelledby etc can be used.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant