Skip to content

Addon Docs: Fix SyntaxHighlighter "Copy" button by avoiding potentially mocked clipboard #31682

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

Merged
merged 1 commit into from
Jun 6, 2025

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Jun 6, 2025

Closes #31626

What I did

Use clipboard from top frame to avoid potentially mocked clipboard in the preview.
This won't fix the problem when viewing a story standalone (without a manager), but that is unavoidable.

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-storybook/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

Fixes the SyntaxHighlighter component's "Copy" button by accessing clipboard API from the top-level window instead of the potentially mocked iframe context.

  • Modified clipboard access in code/core/src/components/components/syntaxhighlighter/syntaxhighlighter.tsx to use top frame's clipboard API
  • Adds safer clipboard API access with optional chaining
  • Note: Won't work in standalone story mode (without manager), but this is an acceptable limitation
  • Improves reliability of code copying in docs while preserving all other SyntaxHighlighter functionality

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.

LGTM

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

Copy link

nx-cloud bot commented Jun 6, 2025

View your CI Pipeline Execution ↗ for commit fd1e207.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 27s View ↗

☁️ Nx Cloud last updated this comment at 2025-06-06 08:09:57 UTC

@ghengeveld ghengeveld changed the title Docs: Fix SyntaxHighlighter "Copy" button by avoiding potentially mocked clipboard Addon Docs: Fix SyntaxHighlighter "Copy" button by avoiding potentially mocked clipboard Jun 6, 2025
@ghengeveld ghengeveld merged commit 5ee8cf4 into next Jun 6, 2025
58 of 64 checks passed
@ghengeveld ghengeveld deleted the fix-syntaxhighlighter-copy-action branch June 6, 2025 12:38
@github-actions github-actions bot mentioned this pull request Jun 6, 2025
19 tasks
@ghengeveld ghengeveld added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jun 7, 2025
@superrover
Copy link

superrover commented Jun 9, 2025

This PR partially addresses the issue by delegating write operations to window.top.navigator.clipboard, but full functionality still requires proper allow="clipboard-write" permissions on the SB's iframe container. This is required for the use cases where you would have implemented your own copy to clipboard util that would still rely on SB's iframe instance.

This was referenced Jun 10, 2025
JReinhold pushed a commit that referenced this pull request Jun 10, 2025
…-action

Addon Docs: Fix SyntaxHighlighter "Copy" button by avoiding potentially mocked clipboard

(cherry picked from commit 5ee8cf4)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 10, 2025
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.

LGTM

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Unable to paste from clipboard in v9
3 participants