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

Question

我刚刚开始使用 Storybook 作为我正在开发的 UI 组件库。我想将为 JS 类方法和属性编写的 JSDoc 提取到 Storybook 中并创建一个 Doc。Storybook 确实支持通过读取 React 组件的 propTypes 创建文档。是否有插件或某种方式可以对 JS 类执行相同的操作。

我正在使用最新的故事书6。

提前致谢

Answer 1

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

表单验证器.stories.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 文件。

表单验证器.stories.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} />