Skip to content

docs: Reformat TextArea Accessibility - #4058

Merged
williamjstanton merged 16 commits into
Workday:a11yfrom
moaan-workday:text-area-reformat
Aug 7, 2026
Merged

docs: Reformat TextArea Accessibility#4058
williamjstanton merged 16 commits into
Workday:a11yfrom
moaan-workday:text-area-reformat

Conversation

@moaan-workday

@moaan-workday moaan-workday commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR rewrites the TextArea Storybook accessibility section to match the newer AI-codegen documentation template (the same pattern used for Dialog and FormField). It turns a short paragraph into a comprehensive accessibility guide.

  • Documents the generated ID convention: label-{id}, input-{id}, hint-{id}.
  • Clarifies that FormField.Input wires aria-labelledby, aria-describedby, aria-invalid, and required automatically.
  • Notes that error="caution" is visual-only and does not set aria-invalid.
  • Warns that FormField.Input always sets aria-describedby="hint-{id}" when an id exists, so omitting FormField.Hint creates a dangling reference.
  • Provides a debounced AriaLiveRegion example for character counts and links to the existing guide.
  • Adds a requirements table covering visible labels, wiring, hints/errors, required/disabled states, character limits, placeholders, stable IDs, and resize constraints.

Release Category

Documentation

Checklist

For the Reviewer

  • PR title is short and descriptive
  • PR summary describes the change (Fixes/Resolves linked correctly)
  • PR Release Notes describes additional information useful to call out in a release message or removed if not applicable
  • Breaking Changes provides useful information to upgrade to this code or removed if not applicable

Where Should the Reviewer Start?

Areas for Feedback? (optional)

  • Code
  • Documentation
  • Testing
  • Codemods

Testing Manually

Screenshots or GIFs (if applicable)

Thank You Gif (optional)

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (3)
  • support
  • prerelease/minor
  • prerelease/major

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4752927c-20ac-42ed-9f82-307525964305

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@moaan-workday moaan-workday changed the title Text area reformat docs: text area a11y reformat Jul 10, 2026
@moaan-workday moaan-workday changed the title docs: text area a11y reformat docs: Reformat TextArea Accessibility Jul 10, 2026
Comment thread modules/react/text-area/stories/TextArea.mdx
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
@cypress

cypress Bot commented Jul 27, 2026

Copy link
Copy Markdown

Workday/canvas-kit    Run #11460

Run Properties:  status check passed Passed #11460  •  git commit d5b0e07367 ℹ️: Merge fd7345d1579e6d55af0816e5982a65a1df484f56 into 1043c2ab55c5a6e4ceb9343e29be...
Project Workday/canvas-kit
Branch Review text-area-reformat
Run status status check passed Passed #11460
Run duration 02m 21s
Commit git commit d5b0e07367 ℹ️: Merge fd7345d1579e6d55af0816e5982a65a1df484f56 into 1043c2ab55c5a6e4ceb9343e29be...
Committer moaan-workday
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 17
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 809
View all changes introduced in this branch ↗︎
UI Coverage  19.64%
  Untested elements 1528  
  Tested elements 371  
Accessibility  99.44%
  Failed rules  5 critical   5 serious   0 moderate   2 minor
  Failed elements 68  

Co-authored-by: Cursor <cursoragent@cursor.com>

@williamjstanton williamjstanton left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Putting in some feedback of my own to help move this along. I think we have a couple of big questions to work through:

  1. Should we be focusing on React TSX code, or DOM renders for AI code-gen? What's more deterministic?
  2. How do we avoid duplicating docs? How are we splitting concerns between what TextArea does and what FormField is doing?

Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
@williamjstanton
williamjstanton requested a review from purvas12 July 29, 2026 14:55
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx
Comment thread modules/react/text-area/stories/TextArea.mdx
moaan-workday and others added 5 commits July 31, 2026 15:59
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>
moaan-workday and others added 3 commits August 4, 2026 14:49
…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 williamjstanton left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx
Comment thread modules/react/text-area/stories/TextArea.mdx Outdated
Comment thread modules/react/text-area/stories/TextArea.mdx
@williamjstanton
williamjstanton marked this pull request as ready for review August 5, 2026 17:19
@williamjstanton
williamjstanton requested a review from a team as a code owner August 5, 2026 17:19

@williamjstanton williamjstanton left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I already reviewed while in draft state and looked good.

@purvas12 purvas12 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@williamjstanton
williamjstanton merged commit af821d3 into Workday:a11y Aug 7, 2026
14 of 17 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.

5 participants