在故事书中编写普通JS类的文档 form-validators.stories.ts form-validators.stories.mdx

问题描述

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

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

预先感谢

解决方法

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

form-validators.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文件。

form-validators.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} />

documentation javascript jsdoc storybook