Skip to content

docs: Add AI functionality disclosure example to Tooltip docs - #4132

Open
mig-builds wants to merge 1 commit into
Workday:masterfrom
mig-builds:contrib/issue-4125-add-a-this-functionality-is-powered-by-ai-
Open

docs: Add AI functionality disclosure example to Tooltip docs#4132
mig-builds wants to merge 1 commit into
Workday:masterfrom
mig-builds:contrib/issue-4125-add-a-this-functionality-is-powered-by-ai-

Conversation

@mig-builds

@mig-builds mig-builds commented Aug 8, 2026

Copy link
Copy Markdown

Summary

Resolves: #4125

Adds a new "AI Functionality Disclosure" example and docs section to the Tooltip page, showing how to use type="description" to disclose that a control triggers AI-powered functionality (e.g. "This functionality is powered by AI.") to assistive technology users, without changing the element's visible label.

Release Category

Documentation

Release Note


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)

Where Should the Reviewer Start?

modules/react/tooltip/stories/Tooltip.mdx and the new modules/react/tooltip/stories/examples/AIDisclosure.tsx

Areas for Feedback? (optional)

  • Documentation

Testing Manually

Docs-only MDX + example component change, following the existing example pattern in this file (e.g. DescriptionType). I could not run this repo's full yarn/lerna build and typecheck scripts in my environment, so please double-check the MDX renders as expected in Storybook.

@mig-builds
mig-builds requested a review from a team as a code owner August 8, 2026 21:13
@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Added an AIDisclosure tooltip example. The Tooltip documentation explains how description tooltips use aria-description to disclose AI functionality to assistive technology users.

Changes

AI disclosure example

Layer / File(s) Summary
AI disclosure component
modules/react/tooltip/stories/examples/AIDisclosure.tsx
Added the exported AIDisclosure component with a “Summarize” button and AI-powered functionality tooltip.
Tooltip documentation
modules/react/tooltip/stories/Tooltip.mdx
Imported the example and documented AI functionality disclosure with description tooltips and aria-description.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested labels: needs-a11y

Suggested reviewers: rayredgoose, mannycarrera4

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The changes satisfy issue #4125 by adding the requested AI disclosure example and documentation section using a descriptive tooltip.
Out of Scope Changes check ✅ Passed The changes are limited to the requested Tooltip documentation and its example component.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the added AI functionality disclosure example in the Tooltip documentation.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 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.

@mig-builds mig-builds changed the title Add AI functionality disclosure example to Tooltip docs docs: add AI functionality disclosure example to Tooltip docs Aug 8, 2026
@mig-builds mig-builds changed the title docs: add AI functionality disclosure example to Tooltip docs docs: Add AI functionality disclosure example to Tooltip docs Aug 8, 2026
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.

Add a "This functionality is powered by AI." Disclosure example to our Tooltip docs

1 participant