From 27655a997d6e5cd48cea58af7e46bf5ae5eac88f Mon Sep 17 00:00:00 2001 From: Emma Jiang <31319479+emmayjiang@users.noreply.github.com> Date: Thu, 7 Nov 2024 13:47:20 -0800 Subject: [PATCH] docs(v8 coachmark): Add a11y documentation (#33228) --- .../src/react/Coachmark/docs/CoachmarkBestPractices.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/react-examples/src/react/Coachmark/docs/CoachmarkBestPractices.md b/packages/react-examples/src/react/Coachmark/docs/CoachmarkBestPractices.md index 54672055069b8..bbe5dda628451 100644 --- a/packages/react-examples/src/react/Coachmark/docs/CoachmarkBestPractices.md +++ b/packages/react-examples/src/react/Coachmark/docs/CoachmarkBestPractices.md @@ -4,3 +4,8 @@ - Coach marks can be standalone or sequential. Sequential coach marks should be used sparingly to walk through complex multistep interactions. It’s recommended that a sequence of coach marks doesn’t exceed three steps. - Coach marks are designed to only hold teaching bubbles. - Coach mark size, color, and animation shouldn’t be altered. + +### Accessibility + +- Coach marks are difficult to access for screenreaders and keyboard users. Consider providing an alternative display of the information in the coach mark through text documentation or a video walkthrough. +- Keyboard users can press Alt+C to open the coach mark.