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

UI: Remove keyboard shortcut hint in search bar on mobile viewports #25866

Merged

Conversation

tusharwebd
Copy link
Contributor

Closes #25816

What I did

This commit resolves issue: 25816 (mobile view should not hint at keyboard shortcut). Used react hooks to check window width whenever it changes, if the window width is less that 768 px, we consider it as mobile view (widely accepted practice) and not show the keyboard shortcuts.

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

  1. Ran end to end test yarn task --task e2e-tests --template=react-vite/default-ts --start-from=auto
  2. Open test Storybook in my browser using yarn start
  3. Verified story views are not affected. Only change is keyboard shortcut is not displayed in mobile view.

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>

…bar.

This commit resolves issue: 25816 (mobile view should not hint at keyboard shortcut).
@yannbf
Copy link
Member

yannbf commented Feb 5, 2024

Hey @tusharwebd thanks for your contribution! @ndelangen would you mind checking this out? Thanks!

@yannbf yannbf changed the title [Bug Fix] Mobile view should not hint at keyboard shortcut in search bar UI: Remove keyboard shortcut hint in search bar on mobile viewports Feb 5, 2024
@cdedreuille
Copy link
Contributor

There's no need to create a new function to know if you are on mobile. We already have a hook for this:

const { isMobile } = useLayout();

@tusharwebd
Copy link
Contributor Author

There's no need to create a new function to know if you are on mobile. We already have a hook for this:

const { isMobile } = useLayout();

Makes sense. Will update commit with this function.

@tusharwebd
Copy link
Contributor Author

Updated branch with commits to remove unnecessary config changes and use existing function to check viewport instead of creating a new hook.

@tusharwebd
Copy link
Contributor Author

Thanks for approving! Can someone merge this for me please? I am not able to merge because of this:
Merging is blocked The base branch restricts merging to authorized users. [Learn more about protected branches.](https://docs.github.com/articles/about-protected-branches/)

@ndelangen ndelangen merged commit 6b09633 into storybookjs:next Feb 6, 2024
47 of 48 checks passed
@github-actions github-actions bot mentioned this pull request Feb 6, 2024
21 tasks
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.

[Bug]: mobile view should not hint at keyboard shortcut
4 participants