Storybook 文档更新指南｜TypeScript 优先与全面 API 参考

ChatGPT可以帮助完成许多任务，但如果您想深入学习Storybook，最好的资源仍然是Storybook的官方文档。为了进一步提升开发者的学习体验，Storybook团队推出了一系列新功能和优化。以下是主要更新内容的详细介绍。

新的API参考资料

在社区反馈中，功能、库和插件的API信息一直是最受关注的主题之一。为此，Storybook文档新增了一个专门的API参考部分，致力于成为全面的技术资源。这个部分从API参考开始，未来将逐步扩展到参数和装饰器等内容。

为了更好地收集用户反馈，每个文档页面都新增了一个反馈小部件，方便用户直接分享对特定文档的意见和建议。如果您发现某些文档页面需要改进，可以通过反馈小部件告诉我们，或者直接提交PR为文档贡献力量。

TypeScript优先的文档

TypeScript已成为大多数开发者的首选语言。为此，Storybook文档中的代码示例默认以TypeScript呈现（如果可用），否则会回退到JavaScript版本。此外，所有TypeScript代码段均兼容TypeScript 4.9版本，这得益于TS 4.9引入的“满足”功能，为Storybook配置和故事提供了更高的类型安全性。

为了进一步优化开发者体验，Storybook新增了以下功能：

• 浏览器会记住您的代码语言和渲染器选择，无需每次手动重新设置。
• 包含版本、渲染器和代码语言菜单的工具栏现已固定在页面顶部，便于快速查看和调整设置。

全面的代码片段

代码片段在开发者学习过程中起着至关重要的作用。为了确保代码片段的实用性和准确性，Storybook团队对文档和教程中的每一个代码片段进行了全面审核，并为每个核心渲染器（React、Vue、Angular和Web组件）提供了相应的代码示例。

此外，所有CSF 2代码段已转换为新的CSF 3格式。如果您尚未准备好升级，也可以通过链接访问旧版本的代码片段。

总结

Storybook团队始终致力于为开发者提供更优质的学习资源和体验。通过新增API参考文档、TypeScript优先的代码示例以及全面的代码片段更新，开发者可以更高效地学习和使用Storybook。同时，团队也非常欢迎社区的反馈和贡献，您的意见将帮助我们不断改进和完善。

如果您对Storybook的文档改进有任何建议，欢迎通过反馈小部件或GitHub issues与我们联系。让我们共同推动Storybook的发展！

原文链接: https://storybook.js.org/blog/docs-updates/