Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 8 commits into
base: next
Choose a base branch
from

Conversation

kendallgassner
Copy link

@kendallgassner kendallgassner commented Aug 30, 2024

Relates to:

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.

A video showing the toggle interaction toolbar button being toggled on and off.

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>

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

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

nx-cloud bot commented Aug 30, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 74fbf23. 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

Sent with 💌 from NxCloud.

@kendallgassner kendallgassner changed the title Create a toolbar button that allows users to disable/enable interaction A11y: Create a toolbar button that allows users to disable/enable interaction Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants