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

Addon Docs: Support Stencil based display names in source snippets #26592

Merged
merged 1 commit into from
Mar 21, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Mar 21, 2024

Closes #22287

What I did

The jsx decorator parsing now supports extracting display names which are attached in a forwardRef component. This is commonly done in Stencil-generated components and it was a use case we were missing

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

I reproduced the issue by creating a stencil project based on the docs and debugging how stencil generates React components. The unit tests reproduce how that works, and should suffice.

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>

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch addon: docs ci:normal labels Mar 21, 2024
Copy link

nx-cloud bot commented Mar 21, 2024

☁️ Nx Cloud Report

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

@yannbf yannbf enabled auto-merge March 21, 2024 10:09
@yannbf yannbf merged commit d7db290 into next Mar 21, 2024
56 of 61 checks passed
@yannbf yannbf deleted the yann/fix-forward-ref-docgen-usecase branch March 21, 2024 10:22
@github-actions github-actions bot mentioned this pull request Mar 21, 2024
11 tasks
storybook-bot pushed a commit that referenced this pull request Mar 21, 2024
…n-usecase

Addon Docs: Support Stencil based display names in source snippets

(cherry picked from commit d7db290)
@github-actions github-actions bot mentioned this pull request Mar 21, 2024
5 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 21, 2024
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]: Code of React components showing as <forwardRef>
2 participants