Skip to content

docs: expand accessibility props in README#433

Merged
iamdarshshah merged 2 commits into
masterfrom
docs/accessibility-readme
Jun 6, 2026
Merged

docs: expand accessibility props in README#433
iamdarshshah merged 2 commits into
masterfrom
docs/accessibility-readme

Conversation

@iamdarshshah
Copy link
Copy Markdown
Collaborator

Summary

  • Splits the catch-all "Accessibility attributes" table row into four individual named rows (role, tabIndex, id, aria-*) consistent with the rest of the props table
  • Adds a dedicated Accessibility section with two usage examples showing aria-label and aria-labelledby patterns

Context

Companion to #432, which adds the accessibility props to the component. The README in that PR used a single grouped row which would not be found by someone scanning the table for role or tabIndex by name, and had no usage guidance for consumers implementing screen reader support for the first time.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 6, 2026

Size Change: 0 B

Total Size: 9.51 kB

ℹ️ View Unchanged
Filename Size
dist/index.es.js 4.73 kB
dist/index.js 4.78 kB

compressed-size-action

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.87%. Comparing base (dc9f7f4) to head (cccf1d6).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #433   +/-   ##
=======================================
  Coverage   95.87%   95.87%           
=======================================
  Files           4        4           
  Lines         194      194           
  Branches       65       65           
=======================================
  Hits          186      186           
  Misses          4        4           
  Partials        4        4           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@iamdarshshah iamdarshshah force-pushed the docs/accessibility-readme branch from 0582f9a to b4016b9 Compare June 6, 2026 19:30
@iamdarshshah iamdarshshah merged commit 4b957d0 into master Jun 6, 2026
19 checks passed
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

Successfully merging this pull request may close these issues.

1 participant