storybookjs/storybook

[Feature Request]: Upgrade `Primary`, `Title`, `Subtitle` and `Stories` blocks to the new v7 blocks API

Open

#22,490 opened on May 10, 2023

View on GitHub
 (14 comments) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
feature requestgood first issue

Description

Is your feature request related to a problem? Please describe

Storybook v7 introduced a new API for doc blocks that is based on an of prop and change in parameters location. See https://storybook.js.org/blog/storybook-7-docs/#doc-blocks-api-is-powerful-yet-simple

However the blocks Primary, Title and Subtitle were not fully migrated to the new API.

Describe the solution you'd like

Each block should be changed to match the general blocks API, similar to how eg. the Description block is implemented: https://github.com/storybookjs/storybook/blob/next/code/ui/blocks/src/blocks/Description.tsx It's important that the changes are backwards compatible, and the current usage is still supported, but with a deprecation warning.

Primary

  • Add support for of prop via useOf - only the "meta" type is valid here
  • Document changes
  • Add stories
  • Make sure it is backwards compatible - should still work with name prop, or no prop at all (infers the current component)

Title

  • Add support for of prop via useOf - only the "meta" type is valid here
  • Document changes
  • Add stories
  • Make sure it is backwards compatible - children prop should not be deprecated

Subtitle — #22552 by @joaonunomota

  • Add support for of prop via useOf - only the "meta" type is valid here
  • Default to extracting content from parameters.docs.subtitle
  • Deprecate extracting content from parameters.componentSubtitle
  • Document changes
  • Add stories
  • Make sure it is backwards compatible - children prop should not be deprecated.

Stories

  • Add support for of prop via useOf - only the "meta" type is valid here
  • Default to get title from parameters.docs.stories.title
  • Default to get includePrimaryStory from parameters.docs.stories.includePrimaryStory
  • Document changes
  • Add stories

Additional context

These changes are rather small, so they can be made in one PR or in 4 different PRs. Any new or experienced contributor is free to pick these up.

Note Anyone are free to work on these issues, you don't need to "reserve" it by asking here, just open a pull request with your work when you're done.

Contributor guide

Tech stack
typescriptreact
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactStorybook doc blocksTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests upgrading the Primary, Title, Subtitle, and Stories blocks to the new v7 doc blocks API. The Description block implementation at https://github.com/storybookjs/storybook/blob/next/code/ui/blocks/src/blocks/Description.tsx is the reference. Each block needs an `of` prop using `useOf` (only 'meta' type), backwards compatibility with deprecation warnings, documentation, and stories. The Primary block is already completed and can serve as a template. Subtitle has a related PR (#22552) but no assignees. The maintainer stated changes are small and can be done in one or multiple PRs.
[Feature Request]: Upgrade `Primary`, `Title`, `Subtitle` and `Stories` blocks to the new v7 blocks API · storybookjs/storybook#22490 | Good First Issue