Skip to content

docs: Expand Modal, Popup, and Dialog accessibility for AI codegen - #4144

Open
williamjstanton wants to merge 7 commits into
Workday:a11yfrom
williamjstanton:william-aidocs-modal-popup
Open

docs: Expand Modal, Popup, and Dialog accessibility for AI codegen#4144
williamjstanton wants to merge 7 commits into
Workday:a11yfrom
williamjstanton:william-aidocs-modal-popup

Conversation

@williamjstanton

Copy link
Copy Markdown
Collaborator

Summary

Expands and aligns Accessibility documentation for Modal, Popup, and Dialog to the AI-codegen template (minimum structure, built-in behaviors, requirements, anti-patterns), so agents and consumers get consistent, accurate guidance across the popup family.

  • Modal — Full accessibility section for the blocking dialog pattern (focus trap, assistive sibling hiding, overflow/scroll, accept-only dismiss).
  • Popup — Full accessibility section for compose-your-own hooks (usePopupModel + behavior hooks), including reading-order/aria-owns DIY and when to prefer Dialog or Modal.
  • Dialog — Aligns shared guidance with Modal/Popup (min structure, Custom Target, open-focus patterns, ARIA/DOM depth) while keeping non-modal-only rules (aria-owns, useFocusRedirect, conditional aria-expanded).

Cross-component polish after review:

  • Shared Custom Target / focus-default / open-focus-below wording and cross-links
  • Modal treats aria-expanded / aria-haspopup as an anti-pattern (non-modal only)
  • Input labeling left to FormField / input docs (not duplicated as a popup-family requirement)
  • APG modal dialog pattern cited for Modal; Dialog/Popup point to Modal for that pattern

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?

  1. modules/react/modal/stories/Modal.mdx## Accessibility (canonical modal / blocking pattern)
  2. modules/react/popup/stories/Popup.mdx## Accessibility (compose hooks; prefer Dialog/Modal first)
  3. modules/react/dialog/stories/Dialog.mdx## Accessibility (non-modal; confirm shared vs modal-only deltas)

Areas for Feedback? (optional)

  • Code
  • Documentation
  • Testing
  • Codemods

Focus on:

  • Accuracy of built-in behaviors vs hooks/subcomponents (especially Modal aria-modal="false" and Popup “hooks not auto-applied”)
  • Whether Dialog/Popup aria-expanded guidance and Modal’s anti-pattern are clear enough for codegen
  • Cross-links between the three pages and Inline Popups / Return Focus / Initial Focus

Testing Manually

  1. Run Storybook (yarn start) and open:
    • Components > Popups > Modal → Accessibility
    • Components > Popups > Popup → Accessibility
    • Components > Popups > Dialog → Accessibility
  2. Confirm headings, tables, code samples, and internal/external links render.
  3. Spot-check that min-structure snippets match each component’s Basic Example composition (Overlay/Popper/ButtonGroup, hook composition on Popup).

Screenshots or GIFs (if applicable)

N/A — documentation only.

sheelah and others added 7 commits August 7, 2026 10:24
Add-on to Workday#4100. Adds upgrade guide links to the README for v15 and v16 and a link to our older fonts package README in the fonts guide.

[category:Documentation]
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Reduce cross-component drift in shared a11y guidance while keeping
modal-only and non-modal-only rules distinct.

Co-authored-by: Cursor <cursoragent@cursor.com>
@williamjstanton
williamjstanton requested a review from a team as a code owner August 14, 2026 13:05
@williamjstanton williamjstanton added accessibility documentation Affects documentation ready for review Code is ready for review labels Aug 14, 2026
@coderabbitai

coderabbitai Bot commented Aug 14, 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: ca27caad-886e-449c-b6b7-3920faf51e8f

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

accessibility documentation Affects documentation ready for review Code is ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants