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

Fix: Prevent iframe from capturing mouse events in composed Storybooks #28568

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

Vincentdevreede
Copy link
Contributor

@Vincentdevreede Vincentdevreede commented Jul 12, 2024

What I did

The const previewIframe was directly selecting the iframe #storybook-preview-iframe , but when you are using composed Storybooks the #storybook-ref-* iframe is visible and used. When you resize the panels and your mouse is entering the ref iframe it will capture the mouse event.

Changing the previewIframe selector to the parent #storybook-preview-wrapper it will prevent both iframes to capture the mouse events.

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

  • Create a Storybook with a composed Storybook
  • Create a story and open it
  • Try dragging the panels to the preview iframe

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 76.5 MB 76.5 MB 0 B 1.54 0%
initSize 198 MB 198 MB 45 B -0.98 0%
diffSize 121 MB 121 MB 45 B -0.98 0%
buildSize 7.59 MB 7.59 MB 1 B 0.28 0%
buildSbAddonsSize 1.63 MB 1.63 MB 0 B - 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.3 MB 2.3 MB 1 B Infinity 0%
buildSbPreviewSize 349 kB 349 kB 0 B - 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.47 MB 4.47 MB 1 B Infinity 0%
buildPreviewSize 3.12 MB 3.12 MB 0 B 0.23 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 10.7s 8.2s -2s -513ms -0.71 -30.5%
generateTime 22.6s 24.5s 1.8s 0.96 7.7%
initTime 26.1s 24.7s -1s -422ms 0.68 -5.7%
buildTime 15s 14.4s -545ms 0.13 -3.8%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 8.5s 9.3s 776ms 0.81 8.3%
devManagerResponsive 5.9s 5.6s -282ms 0.04 -5%
devManagerHeaderVisible 751ms 996ms 245ms 3.49 🔺24.6%
devManagerIndexVisible 784ms 1s 267ms 3.93 🔺25.4%
devStoryVisibleUncached 1.3s 1.7s 407ms 1.8 🔺22.8%
devStoryVisible 809ms 1s 263ms 3.81 🔺24.5%
devAutodocsVisible 732ms 910ms 178ms 3.21 🔺19.6%
devMDXVisible 684ms 792ms 108ms 0.93 13.6%
buildManagerHeaderVisible 709ms 885ms 176ms 0.95 19.9%
buildManagerIndexVisible 711ms 895ms 184ms 0.98 20.6%
buildStoryVisible 761ms 939ms 178ms 0.96 19%
buildAutodocsVisible 673ms 727ms 54ms 0.12 7.4%
buildMDXVisible 662ms 1s 400ms 8.83 🔺37.7%

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.

PR Summary

  • Updated iframe selector from #storybook-preview-iframe to #storybook-preview-wrapper in /code/core/src/manager/components/layout/useDragging.ts
  • Prevents mouse events from being captured by the iframe in composed Storybooks
  • Enhances user experience when resizing panels in composed Storybooks

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Jul 12, 2024

☁️ Nx Cloud Report

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

@ndelangen
Copy link
Member

Code change looks good to me, I need to do some manual testing before merging.

Thanks for doing this @Vincentdevreede !!
What a great first contribution to storybook.

@ndelangen ndelangen merged commit 4f9108c into storybookjs:next Jul 16, 2024
48 of 49 checks passed
@github-actions github-actions bot mentioned this pull request Jul 16, 2024
12 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.

3 participants