canvas-kit icon indicating copy to clipboard operation
canvas-kit copied to clipboard

docs: Migrating accessibility guidelines for FormFIeld, TextInput, TextArea

Open williamjstanton opened this issue 2 months ago • 1 comments

Summary

As part of making accessibility a "first class citizen" in Canvas docs, we will be pulling any technical information for developers off of the design site, and into the Canvas repository.

FormField, TextInput, and TextArea are my next focus.

Release Category

Documentation

Checklist

  • [ ] MDX documentation adheres to Canvas Kit's Documentation Guidelines
  • [ ] Label ready for review has been added to PR

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?

modules/react/form-field/stories/FormField.mdx modules/react/text-input/stories/TextInput.mdx modules/react/text-area/stories/TextArea.mdx

Important notes about using InputGroup:

modules/react/text-input/stories/examples/Icons.tsx modules/react/form-field/stories/examples/HiddenLabel.tsx

A really cool new example debouncing an AriaLiveRegion:

modules/docs/mdx/accessibility/AriaLiveRegions.mdx modules/docs/mdx/accessibility/examples/AriaLiveRegions/CommentBoxWithCharLimit.tsx

Areas for Feedback? (optional)

  • [X] Code
  • [X] Documentation
  • [ ] Testing
  • [ ] Codemods

Testing Manually

Screenshots or GIFs (if applicable)

For the InputGroup examples, make sure the text input fields are properly associated to their label elements. (Previously, the id attribute values were incorrectly being set on the InputGroup container element.)

Thank You Gif (optional)

williamjstanton avatar Nov 26 '25 22:11 williamjstanton

Workday/canvas-kit    Run #9969

Run Properties:  status check passed Passed #9969  •  git commit f3a9a4f1a0 ℹ️: Merge 4da4baf3eb1f48664db120184d16ccdbe68012b3 into bde1183f9ea0cf8610dce15036eb...
Project Workday/canvas-kit
Branch Review william-docs-form-fields
Run status status check passed Passed #9969
Run duration 02m 25s
Commit git commit f3a9a4f1a0 ℹ️: Merge 4da4baf3eb1f48664db120184d16ccdbe68012b3 into bde1183f9ea0cf8610dce15036eb...
Committer William Stanton
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 1
Tests that did not run due to a developer annotating a test with .skip  Pending 86
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 850
View all changes introduced in this branch ↗︎
UI Coverage  19.36%
  Untested elements 1539  
  Tested elements 367  
Accessibility  99.33%
  Failed rules  6 critical   5 serious   0 moderate   2 minor
  Failed elements 77  

cypress[bot] avatar Nov 26 '25 22:11 cypress[bot]