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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blocks: Fix Subtitle block for unattached docs pages #25157

Merged
merged 2 commits into from Dec 11, 2023

Conversation

kripod
Copy link
Contributor

@kripod kripod commented Dec 8, 2023

Closes #

What I did

The Subtitle component from @storybook/blocks crashes when used within MDX for a documentation-only page:

image

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!

No manual test is necessary, as the code works analogously with the Title component, which only evaluates useContext(DocsContext).storyById() when children is falsy.

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>

@shilman shilman changed the title fix(Subtitle): crash on unattached docs pages Blocks: Fix Subtitle block for unattached docs pages Dec 11, 2023
@shilman shilman self-assigned this Dec 11, 2023
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks so much for the fix @kripod !!! 馃檹

@shilman shilman merged commit c82e136 into storybookjs:next Dec 11, 2023
47 of 48 checks passed
@shilman shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Dec 11, 2023
storybook-bot pushed a commit that referenced this pull request Dec 11, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 11, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 12, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 12, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 12, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 13, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 13, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 13, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 14, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 14, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 14, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 14, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
storybook-bot pushed a commit that referenced this pull request Dec 15, 2023
Blocks: Fix Subtitle block for unattached docs pages
(cherry picked from commit c82e136)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
block: other bug ci:normal mdx 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.

None yet

2 participants