在故事书中为普通JS类编写文档

Question

我刚刚开始将Storybook用于我正在开发的UI组件库。我想将为JS类方法和属性编写的JSDoc提取到Storybook中并创建一个Doc。Storybook确实支持通过读取其propTypes为React组件创建文档。有没有插件或其他方法可以为JS类做同样的事情。

我在用最新的故事书。

提前感谢

Answer 1

您可以像普通组件一样执行此操作：

表单验证程序.stores.ts

import { FormValidators } from './path';
export default {
title: 'Components/Form Validators',
component: FormValidators,
parameters: {
previewTabs: { canvas: { hidden: true } },
docsOnly: true,
},
} as Meta;
export const Default: Story = () => ({
template: '<div>Test</div>',
});

或者我更喜欢MDX文件。

表单验证程序.stores.mdx

import { ArgsTable } from '@storybook/addon-docs/blocks';
import { Meta } from '@storybook/addon-docs/blocks';
import { FormValidators } from './path';
<Meta
title="Components/Form Validators"
parameters={{ previewTabs: { canvas: { hidden: true } } }}
/>
<ArgsTable of={FormValidators} />