-
Notifications
You must be signed in to change notification settings - Fork 2.9k
chore: a11y docs structure update #24871
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
Conversation
📊 Bundle size reportUnchanged fixtures
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 3215b65:
|
Perf Analysis (
|
| Scenario | Render type | Master Ticks | PR Ticks | Iterations | Status |
|---|---|---|---|---|---|
| Avatar | mount | 1316 | 1295 | 5000 | |
| Button | mount | 960 | 953 | 5000 | |
| FluentProvider | mount | 1588 | 1584 | 5000 | |
| FluentProviderWithTheme | mount | 623 | 634 | 10 | |
| FluentProviderWithTheme | virtual-rerender | 588 | 599 | 10 | |
| FluentProviderWithTheme | virtual-rerender-with-unmount | 631 | 631 | 10 | |
| MakeStyles | mount | 1909 | 1913 | 50000 | |
| SpinButton | mount | 2507 | 2514 | 5000 |
Asset size changesSize Auditor did not detect a change in bundle size for any component! Baseline commit: 62aadfe9a8429fbc5c0660c1e741e5e8171f8f23 (build) |
|
|
||
| How this is read also depends on the screen reader used but a screen reader should read the displayed text consistently with how it would read it in other contexts (i.e., "$1" should be read as "one dollar"). | ||
|
|
||
| ### Styling |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this just a stub for later? should we ommit empty areas for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, though that wasn’t added in this PR. For now I’m just moving the files and updating the docs nav structure, and sometime this week I plan to fill in these sections 😄
| parameters: { | ||
| docs: { | ||
| description: { | ||
| component: [descriptionMd, bestPracticesMd, accessibilityMd].join('\n'), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about linking from the SpinButton to the a11y docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, it’s in the plan! I’m going to be adding an a11y authoring section next to best practices that will link to the full descriptive spec
micahgodbolt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few nits, otherwise good.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Pull request was closed
* master: (29 commits) chore(react-tooltip): update package scaffold (microsoft#24927) chore(react-popover): update package scaffold (microsoft#24925) chore(react-overflow): update package scaffold (microsoft#24926) chore(react-menu): update package scaffold (microsoft#24924) applying package updates chore: Bump workspace-tools to 0.27.0 (microsoft#24914) fix: Make Menu openOnHover prop work again (microsoft#24899) stress test: convert cli scripts to typescript (microsoft#24915) update package manifest to only include v8 controls (microsoft#24839) Stress Test: add random tree (microsoft#24896) chore: Expand scope of dependency mismatch generator (microsoft#24880) chore: run dependency mismatch generator in release pipeline (microsoft#24881) chore: scaffolds react-trigger package (microsoft#24887) applying package updates chore: a11y docs structure update (microsoft#24871) feat: add popupProps to Modal component to allow override internal Popup props (microsoft#24693) fix: Set github user in nightly release pipeline (microsoft#24850) chore(react-aria): restructure folder organization (microsoft#24884) ci(github): fix invalid json string in issues.yml v2 (microsoft#24886) Add react-components/unstable to tsconfig aliases (microsoft#24878) ...
This moves the SpinButton accessibility spec page to Concepts/Developer/Accessibility/Components. The goal is to have an a11y spec per component. There will also be a separate, more concise a11y author implementation section next to best practices.
There are some unrelated whitespace/formatting updates to the spinbutton a11y doc from running prettier.