新的 API 参考、TypeScript 代码片段和文档 DX

我们正在让学习 Storybook 变得比以往更容易

Kyle Gach

2023年6月16日 — @kylegach

最后更新于 2023年6月16日

ChatGPT 可以帮很多忙。但要学习 Storybook，最好的资源是 Storybook 的官方文档。

我们正在推出新功能，帮助您学习 Storybook 并向我们的学习团队发送反馈。下面我们来看看主要更新。

新的 API 参考

Storybook 反馈中的热门主题之一是关于功能、库和插件的 API 信息。因此，我们正在推出文档的 API 参考部分，旨在成为完整的技术资源。它首先包含以下 API 参考：

接下来是 Parameters 和 Decorators，未来还会增加更多。

社区反馈为 Storybook 的文档改进提供了信息。为了帮助您提供反馈，每个页面上都有一个新的反馈小组件，供您分享对特定文档的评论。

提交反馈后，它会收集在一个公开的 GitHub 讨论中。我们的自动化文档机器人提供一个链接，让您可以轻松订阅您关注的问题。

自小组件推出以来的 6 周内，我们很高兴已经收到了 160 多条评分和评论。您的反馈帮助我们改进了 Storybook 7 迁移指南、改进了 ArgTypes 文档以及改进了将 stories 导入测试的文档等其他更改。

您知道有哪些文档页面可以改进吗？开始使用反馈小组件告诉我们。或者甚至提交 PR 并贡献。

TypeScript 已成为大多数开发者的首选语言。如果我们的文档中的代码片段提供 TypeScript 版本（大多数都提供），Storybook 的文档将默认显示 TypeScript。否则，将回退到 JavaScript。

任何提供 TypeScript 版本的代码片段也提供 TypeScript 4.9 版本。这是因为 TS 4.9 支持使用 satisfies，这为您的 Storybook 配置和 stories 带来了更好的类型安全。

作为额外的开发者体验更新，您的代码语言（以及渲染器选择）现在会在浏览器中记住。您不再需要每次手动重新选择这些设置。

最后，包含版本、渲染器和代码语言菜单的工具栏现在会固定在页面顶部。我们希望这能帮助您一目了然地确认这些设置，并在需要时快速更改它们。

我们与新用户的许多交流表明，代码片段在您的学习体验中起着至关重要的作用。它们需要是最新的、相关的并且可以直接使用。

为了配合Storybook 7 的发布，我们审计了所有文档和教程中的每一个代码片段。然后，我们确保每个核心渲染器（React、Vue、Angular 和 Web components）都有每个示例的代码片段。

我们还将所有 CSF 2 片段转换成了新的 CSF 3（并提供了指向旧版本的链接，以供尚未准备好升级的用户使用）。

非常感谢所有为我们的学习内容做出贡献或提供反馈的人。您的贡献塑造了 Storybook 的未来。

我们正在组建一个专门负责创建和维护技术内容的学习团队。如果您有兴趣为 Storybook 做出贡献，我们的学习内容是一个绝佳的起点。

在下方注册我们的邮件列表，第一时间了解新功能和更新。