Storybook里怎么让组件文档自动显示props表格?

艳艳的笔记 阅读 4

我用的是Storybook 7,写了个React组件,也加了PropTypes,但文档页面就是不显示props表格。是不是还要额外配置什么?

试过在.storybook/main.js里开启docs插件,默认应该开了啊。组件代码是这样的:

import React from 'react';
import PropTypes from 'prop-types';

const Button = ({ label }) => <button>{label}</button>;

Button.propTypes = {
  label: PropTypes.string.isRequired,
};

export default Button;

但生成的文档页只有示例,没看到props说明表,到底是哪步漏了?

我来解答 赞 2 收藏
二维码
手机扫码查看
1 条解答
Newb.一茹
在Storybook 7里,光是定义了PropTypes还不太够。官方文档里说你需要确保在组件故事里正确使用argTypesparameters来让文档插件识别这些属性。

首先检查你的.storybook/main.js,确保已经启用了docs插件:
module.exports = {
stories: ['../src/**/*.stories.@(js|jsx|ts|tsx)'],
addons: [
'@storybook/addon-links',
'@storybook/addon-essentials',
'@storybook/addon-docs'
],
};


然后在组件的故事文件里加上doc参数,像这样:
import Button from './Button';

export default {
title: 'Example/Button',
component: Button,
parameters: {
docs: {
source: { type: 'dynamic' }
}
},
argTypes: {
label: { control: 'text' }
},
};

const Template = (args) =>


这下应该就能看到props表格了。有时候还得重启一下Storybook服务,因为缓存问题可能会导致更新不及时。这种小细节真让人抓狂啊。
点赞
2026-03-31 12:01