Storybook文档页面怎么让组件参数都显示出来？有些属性没显示出来

❤文君提问于 2026-02-10 22:44:26 阅读 16

工具

我在用Storybook的MDX文档写组件说明时，发现有些props参数在自动文档里没显示出来。比如给按钮组件加了isLoading属性并写了注释，但生成的表格里就是没这项。

我尝试在组件文件里用JSDoc标注了：

/**
 * @param {boolean} isLoading - 是否显示加载状态
 */

但控制台报错Type 'boolean' is not assignable to type 'undefined'，这是怎么回事？

文档编写

我来解答赞 2 收藏

反馈

1 条解答

美含 ☘︎ Lv1

组件的props要显示出来，必须在组件的PropTypes里定义，或者用TypeScript类型定义。JSDoc不会被Storybook识别。

把isLoading加到组件的PropTypes里：

Button.propTypes = {

  isLoading: PropTypes.bool

};

或者TS接口里：

interface ButtonProps {

  isLoading?: boolean;

}

然后在CSF文件里加上parameters: { docs: { source: { type: 'auto' } } }，搞定。

2026-02-10 23:02