Skip to content

Doc Blocks: Add support for of prop to Stories block#27183

Closed
jorge-ji wants to merge 2 commits into
storybookjs:nextfrom
jorge-ji:update_stories_of_prop
Closed

Doc Blocks: Add support for of prop to Stories block#27183
jorge-ji wants to merge 2 commits into
storybookjs:nextfrom
jorge-ji:update_stories_of_prop

Conversation

@jorge-ji

Copy link
Copy Markdown
Contributor

Co-authored-by: @jiyiru

Partially implements #22490

What I did

  • Add support for of prop via useOf with "meta" as only valid type
  • Added stories
  • Default to get title from parameters.docs.stories.title
  • Default to get includePrimaryStory from parameters.docs.stories.includePrimaryStory
  • Updated documentation, using Blocks: Add of prop to Subtitle #22552 as an example

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!

  1. Run yarn storybook:blocks
  2. Open Storybook in your browser
  3. Access Stories stories

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>

Co-authored-by: Inês Ye Ji <inesji@tecnico.ulisboa.pt>
@nx-cloud

nx-cloud Bot commented May 17, 2024

Copy link
Copy Markdown

☁️ Nx Cloud Report

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

@shilman shilman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you @jorge-ji and @jiyiru ! 🙏 Needs a minor change to be considered for merging. Please let me know if you have any questions

Comment thread code/ui/blocks/src/blocks/Stories.tsx Outdated
interface StoriesProps {
title?: ReactElement | string;
includePrimary?: boolean;
includePrimaryStory?: boolean;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This name change is breaking, so it can't be included in a minor release. Please revert or we will need to wait until Storybook 9 to merge this PR.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for reviewing the code! I reverted includePrimaryStories back to includePrimary.

@shilman shilman added feature request block: other ci:normal Run our default set of CI jobs (choose this for most PRs). addon: docs labels May 25, 2024
Co-authored-by: Inês Ye Ji <inesji@tecnico.ulisboa.pt>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addon: docs block: other ci:normal Run our default set of CI jobs (choose this for most PRs). feature request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants