storybookjs/storybook

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

Open

#22,490 建立於 2023年5月10日

在 GitHub 查看
 (14 留言) (0 反應) (0 負責人)TypeScript (89,909 star) (10,058 fork)batch import
feature requestgood first issue

描述

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.

貢獻者指南

技術棧
typescriptreact
領域
documentationfrontend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
ReactStorybook doc blocksTypeScript
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.