A11y: Create a toolbar button that allows users to disable/enable interaction

[kendallgassner]

Relates to:

• Disable interaction autoplay #25011
• Is there anyway for Stories interaction (play function) to not autoplay? #23616

What I did

In order to improve accessibility on storybook I added a toggle in the toolbar to disable/enable interactions. This will allow users to navigate through the stories without triggering any interactions that could cause motion issues.

I save user preferences in localStorage so that the setting is remembered between sessions.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

1. Open Storybook in your browser
2. Navigate to an interaction story
3. Check that the disable interaction toolbar button is correctly rendered and by default interactions play
4. Press the disable interaction toolbar button and check that interactions do not play as you navigate throughout storybook
5. Press the enable interaction toolbar button again and check that interactions do play as you navigate throughout storybook

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

name	before	after	diff	z	%
createSize	0 B	0 B	0 B	-	-
generateSize	78.5 MB	78.5 MB	0 B	1.99	0%
initSize	151 MB	151 MB	1.34 kB	-0.41	0%
diffSize	72.6 MB	72.6 MB	1.34 kB	-0.64	0%
buildSize	6.77 MB	6.77 MB	852 B	-0.88	0%
buildSbAddonsSize	1.5 MB	1.5 MB	730 B	-0.88	0%
buildSbCommonSize	195 kB	195 kB	0 B	-	0%
buildSbManagerSize	1.83 MB	1.83 MB	0 B	-0.88	0%
buildSbPreviewSize	270 kB	270 kB	122 B	-0.9	0%
buildStaticSize	0 B	0 B	0 B	-	-
buildPrebuildSize	3.8 MB	3.8 MB	852 B	-0.88	0%
buildPreviewSize	2.97 MB	2.97 MB	0 B	-1.2	0%
testBuildSize	0 B	0 B	0 B	-	-
testBuildSbAddonsSize	0 B	0 B	0 B	-	-
testBuildSbCommonSize	0 B	0 B	0 B	-	-
testBuildSbManagerSize	0 B	0 B	0 B	-	-
testBuildSbPreviewSize	0 B	0 B	0 B	-	-
testBuildStaticSize	0 B	0 B	0 B	-	-
testBuildPrebuildSize	0 B	0 B	0 B	-	-
testBuildPreviewSize	0 B	0 B	0 B	-	-

name	before	after	diff	z	%
createTime	6s	14.4s	8.4s	0.02	58.2%
generateTime	19.7s	24.2s	4.4s	1.23	18.3%
initTime	15.5s	15.4s	-71ms	0.29	-0.5%
buildTime	8.9s	9s	91ms	-0.73	1%
testBuildTime	0ms	0ms	0ms	-	-
devPreviewResponsive	7s	6.6s	-438ms	-0.55	-6.6%
devManagerResponsive	4.6s	4.2s	-346ms	-0.55	-8.1%
devManagerHeaderVisible	554ms	537ms	-17ms	-0.64	-3.2%
devManagerIndexVisible	588ms	570ms	-18ms	-0.62	-3.2%
devStoryVisibleUncached	1.1s	1s	-99ms	-0.36	-9.3%
devStoryVisible	583ms	569ms	-14ms	-0.64	-2.5%
devAutodocsVisible	467ms	480ms	13ms	-0.44	2.7%
devMDXVisible	473ms	546ms	73ms	0.02	13.4%
buildManagerHeaderVisible	529ms	487ms	-42ms	-0.5	-8.6%
buildManagerIndexVisible	542ms	490ms	-52ms	-0.57	-10.6%
buildStoryVisible	567ms	562ms	-5ms	-0.33	-0.9%
buildAutodocsVisible	470ms	473ms	3ms	-0.49	0.6%
buildMDXVisible	509ms	417ms	-92ms	-0.81	-22.1%

Greptile Summary

This PR introduces a new feature to Storybook that allows users to disable/enable interactions, improving accessibility by preventing unwanted motion. Here's a summary of the key changes:

• Added new InteractionToggle component in code/addons/interactions/src/components/InteractionToggle.tsx
• Modified code/addons/interactions/src/manager.tsx to integrate the new toggle into the Storybook UI
• Updated code/core/src/preview-api/modules/preview-web/render/StoryRender.ts to respect the interaction toggle state

Key points:

• The toggle state is persisted in localStorage for user preference across sessions
• The toggle appears only in story view mode as a toolbar button
• When interactions are disabled, the story's play function is skipped
• Improves accessibility by allowing users to navigate stories without triggering potentially disruptive interactions

[greptile-apps]

_{3 file(s) reviewed, 5 comment(s)
Edit PR Review Bot Settings}

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ef5294e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 1 target

• nx run-many -t build --parallel=3

---

Sent with 💌 from NxCloud.

[kendallgassner]

Hi @JReinhold,

I'm hoping to get this accessibility feature into Storybook, as the motion of Interactions has been problematic for some team members. We love using Interactions but need a way to disable them on page load for users with reduced motion preferences. Is there anything I can do to help move this PR forward? Thanks in advance!

[kendallgassner]

@shilman so sorry to keep being noisy... I am really eager to get an accessibility fix out for this feature 🙏 !