fix(clear-button): updates documentation, examples and adds tests for clear button accessibility #5861
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixed accessibility violations in the
<sp-clear-button>documentation by adding the requiredlabelattribute to all examples. The component implementation already correctly handles thelabelattribute (via theLikeAnchormixin), but the documentation examples were missing it, causing WCAG 2.1 Level A violations (4.1.2 Name, Role, Value) when rendered on the documentation site.Additionally:
ClearButtonoverridesbuttonContentand does not render slot content)ClearButton.tsto accurately document thelabelattribute instead of the non-functional slotaria-labelbehaviorMotivation and context
Users running Axe DevTools on https://swcpreviews.z13.web.core.windows.net/pr-5861/docs/components/clear-button reported "ARIA commands must have an accessible name" violations. The clear button examples were missing the
labelattribute, which is the only way to provide an accessible name since the component only renders an icon (no slot content).Related issue(s)
Author's checklist
Reviewer's checklist
Manual review test cases
Verify all clear-button examples on documentation page have accessible names
Verify clear button aria-label is set correctly
<sp-clear-button label="Clear">elementrole="button"andaria-label="Clear"on the host element