storybook [文档]:在故事文档块中包含主注解是错误的,

gev0vcfq  于 3个月前  发布在  其他
关注(0)|答案(1)|浏览(26)

描述问题

includePrimary 选项的文档中,有这样一个备注:
💡 如果一个故事文件只包含一个故事并且 includePrimary={true},那么 Stories 块将不会渲染任何内容,以避免可能出现的令人困惑的情况。
遗憾的是,这并不是真的。code for the Stories block 没有产生这种效果的逻辑,而且据我所知,通过查看 Git 历史记录,它从未做过这样的事情。
这是一个很大的遗憾,因为这个功能正是我想要的。我已经更新了我的故事书中的文档模板为

<Meta isTemplate />
<Title />
<Subtitle />
<Description />
<Stories />

## Component reference

<Primary />
<Controls />

,所以如果只有一个主要的故事,它基本上会渲染两次相同的故事(一次在 Stories > 主要部分下,然后再次在组件参考旁边与控件一起)。不幸的是,由于这种行为似乎从来没有存在于历史的任何地方,我无法将其作为错误报告打开。实现文档描述的行为将是一个破坏性的变化。 https://x.co/sadtrombone

附加背景信息

如果有人知道可以在不需要为每个只有主要故事的组件编写自定义文档模板的情况下实现这种行为的方法,我洗耳恭听。我能想到的唯一方法是将我的模板更改为传递 includePrimary={false} ,但这样的话,我可能需要在很多情况下添加 Primary2 ,以确保我的示例是正确的。

pxyaymoc

pxyaymoc1#

我的同事@ashley-peris 指向了我 this issuethis PR,它们的实现非常令人惊讶(对我来说)——这种特殊处理发生在 DocsPage。似乎我遇到的问题只在你提供自定义 parameters.page.docs 时发生,尽管在文档中记录为 Stories 文档块的行为——实际上,单独使用的 Stories 文档块永远不会产生这种行为。我现在非常不确定这是否算作代码错误、文档错误还是两者都有!

相关问题