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

Shortcuts: Require modifier key to trigger shortcuts (F,A,D,S,T,/) #25625

Merged
merged 11 commits into from
Jan 18, 2024

Conversation

cdedreuille
Copy link
Contributor

@cdedreuille cdedreuille commented Jan 17, 2024

Closes #16022

What I did

In this PR I'm modifying the default shortcuts to avoid having shortcuts being triggered unintentionally. I added Alt before the first 6 shortcuts transforming from S to Alt + S.

I also replaced / for search into command + K as we are exploring updating our search into a command palette and command + k is a well known shortcut for that.

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!

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>

@cdedreuille cdedreuille self-assigned this Jan 17, 2024
@cdedreuille cdedreuille added maintenance User-facing maintenance tasks ci:daily Run the CI jobs that normally run in the daily job. ui labels Jan 17, 2024
@ndelangen ndelangen changed the title UI: Update default shortcuts Shortcuts: Require modifier key to trigger shortcuts (F,A,D,S,T,/) Jan 17, 2024
Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

Code looks good, but it needs a migration note.

@cdedreuille
Copy link
Contributor Author

@JReinhold I updated the shortcuts to use Alt instead of command for most of them except for search that will stay as command + K` to match what others are doing with their command action. I also added migration guides as you suggested.

@cdedreuille
Copy link
Contributor Author

It seems we have flaky E2E tests. Since all other tests passed, we discussed this with @JReinhold and he gave me approval to merge this PR directly since the E2E bug is very unlikely related to this issue.

@cdedreuille cdedreuille merged commit b03191d into next Jan 18, 2024
100 of 105 checks passed
@cdedreuille cdedreuille deleted the charles-update-shortcuts branch January 18, 2024 10:36
@github-actions github-actions bot mentioned this pull request Jan 18, 2024
18 tasks
@jonniebigodes jonniebigodes mentioned this pull request Jan 21, 2024
8 tasks
@adrian-cocoara-lgp
Copy link

Hello @cdedreuille,
These changes broke some of our Test Cases since the shortcuts keys have changed.
I checked the documentation if there is any way these shortcuts are configurable, but I can't find anything.
Is there any way I can revert them to the values of Storybook 7? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:daily Run the CI jobs that normally run in the daily job. maintenance User-facing maintenance tasks ui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider changing S / D / F / T / A keyboard shortcuts
4 participants