如何解决在故事书中编写普通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} />
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。