docs: Reformat TextArea Accessibility - #4058
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (3)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks 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 |
Workday/canvas-kit
|
||||||||||||||||||||||||||||||||||||||||
| Project |
Workday/canvas-kit
|
| Branch Review |
text-area-reformat
|
| Run status |
|
| Run duration | 02m 21s |
| Commit |
|
| Committer | moaan-workday |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
|
|
0
|
|
|
0
|
|
|
17
|
|
|
0
|
|
|
809
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
19.64%
|
|
|---|---|
|
|
1528
|
|
|
371
|
Accessibility
99.44%
|
|
|---|---|
|
|
5 critical
5 serious
0 moderate
2 minor
|
|
|
68
|
Co-authored-by: Cursor <cursoragent@cursor.com>
williamjstanton
left a comment
There was a problem hiding this comment.
Putting in some feedback of my own to help move this along. I think we have a couple of big questions to work through:
- Should we be focusing on React TSX code, or DOM renders for AI code-gen? What's more deterministic?
- How do we avoid duplicating docs? How are we splitting concerns between what TextArea does and what FormField is doing?
…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>
williamjstanton
left a comment
There was a problem hiding this comment.
I already reviewed while in draft state and looked good.
Summary
This PR rewrites the
TextAreaStorybook accessibility section to match the newer AI-codegen documentation template (the same pattern used forDialogandFormField). It turns a short paragraph into a comprehensive accessibility guide.label-{id},input-{id},hint-{id}.FormField.Inputwiresaria-labelledby,aria-describedby,aria-invalid, andrequiredautomatically.error="caution"is visual-only and does not setaria-invalid.FormField.Inputalways setsaria-describedby="hint-{id}"when anidexists, so omittingFormField.Hintcreates a dangling reference.AriaLiveRegionexample for character counts and links to the existing guide.Release Category
Documentation
Checklist
ready for reviewhas been added to PRFor the Reviewer
Where Should the Reviewer Start?
Areas for Feedback? (optional)
Testing Manually
Screenshots or GIFs (if applicable)
Thank You Gif (optional)