docs(checkbox): Update accessibility docs and fix code examples - #4157
Closed
moaan-workday wants to merge 42 commits into
Closed
docs(checkbox): Update accessibility docs and fix code examples#4157moaan-workday wants to merge 42 commits into
moaan-workday wants to merge 42 commits into
Conversation
Replace narrative accessibility guidance with an MCP-oriented structure (minimum structure, model config, requirements, anti-patterns) so agents can implement accessible Dialogs without duplicating built-in behavior. Co-authored-by: Cursor <cursoragent@cursor.com>
Consolidate model config and custom targets into Accessibility Requirements, add focus-management defaults with developer prompts, and dedupe overlapping guidance so codegen tools get a clearer happy path and conditional overrides. Co-authored-by: Cursor <cursoragent@cursor.com>
Add conditional-path snippets, codegen summary, and default-focus guidance while preserving the existing requirements structure; align the minimum accessible example with the Basic story layout. Co-authored-by: Cursor <cursoragent@cursor.com>
Restructure the accessibility section with built-in behaviors, DOM examples, developer requirements, and anti-patterns so assistive technology wiring is clearer for form fields and grouped controls. Co-authored-by: Cursor <cursoragent@cursor.com>
Align FormField accessibility docs with the Dialog pattern: add minimum structure, do-not-duplicate guardrails, keyboard/screen reader expectations, codegen-friendly requirements table, and fix FormFieldGroup usage to match role="group" implementation. Co-authored-by: Cursor <cursoragent@cursor.com>
…ormField docs: Update FormField accessibility section
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…ialog docs(Dialog): Add accessibility guidance for AI codegen
Restructure Menu accessibility docs to match the Dialog/FormField pattern with minimum structure, built-in behaviors, requirements, and anti-patterns for codegen. Co-authored-by: Cursor <cursoragent@cursor.com>
Simplify minimum structure, remove programmatic open without Menu.Target, clarify custom target guidance, and document that mode="multiple" is not accessible with Menu.Item. Co-authored-by: Cursor <cursoragent@cursor.com>
docs(menu): expand accessibility guidance for AI codegen
Co-authored-by: Cursor <cursoragent@cursor.com>
…ity requirement and how to satisfy table
Clarify programmatic focus, lean keyboard and anti-patterns, and defer shared FormField DOM and anti-pattern guidance to FormField docs. Co-authored-by: Cursor <cursoragent@cursor.com>
…reformat' into pr/4058 Resolve TextArea.mdx conflicts by keeping the FormField DOM pointer and lean anti-patterns, restoring character-limit guidance, and combining the slimmed requirements table with programmatic focus and resize rows. Co-authored-by: Cursor <cursoragent@cursor.com>
Align minimum-structure wording with Basic, slim the codegen summary to match the requirements table, and drop duplicated character-limit prose. Co-authored-by: Cursor <cursoragent@cursor.com>
…m's Enter key guardrail
…Behaviors aria-describedby, placeholder, and error wiring are documented in FormField accessibility and Anti-Patterns. Co-authored-by: Cursor <cursoragent@cursor.com>
Resize is a CSS prop documented in Usage; not an accessibility requirement row. Co-authored-by: Cursor <cursoragent@cursor.com>
docs: Reformat TextArea Accessibility
The a11y/master merge kept both copies of the DialogStoriesMeta import, which Storybook's MDX parser rejects as a redeclaration. Co-authored-by: Cursor <cursoragent@cursor.com>
…ccessible name FormField.Input sets aria-labelledby and overrode Checkbox's own label. FormFieldGroup.Input does not, so the visible "I agree to the terms" remains the accessible name and "Confirm" is group context. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
williamjstanton
added
accessibility
documentation
Workday/canvas-kit
 |
||||||||||||||||||||||||||||||||||||||||
| Project |
Workday/canvas-kit
|
| Branch Review |
checkbox-mdx-accessibility
|
| Run status |
|
| Run duration | 02m 28s |
| Commit |
|
| Committer | moaan-workday |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
 |
0
|
 |
0
|
 |
17
|
 |
0
|
 |
827
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
19.69%
|
|
|---|---|
|
|
1540
|
|
|
375
|
Accessibility
99.47%
|
|
|---|---|
|
|
5 critical
5 serious
0 moderate
2 minor
|
|
|
72
|
williamjstanton
changed the title
Collaborator
|
This one was branched off of |
Contributor
Author
|
Continuing work on new PR: #4164 |
1 similar comment
Contributor
Author
|
Continuing work on new PR: #4164 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Summary
This PR adds accessibility documentation for the Checkbox component and fixes accessibility errors in the code examples.
Key updates:
Motivation
To ensure consumers of Canvas Kit have accurate accessibility guidance and accessible code examples when implementing the Checkbox component.
Release Category
Documentation
Checklist
ready for reviewhas been added to PRFor the Reviewer
Areas for Feedback? (optional)
Testing Manually
yarn startto launch Storybook locally.