未生成 Storybook MUI v5 文档

Posted

技术标签:

【中文标题】未生成 Storybook MUI v5 文档【英文标题】:Storybook MUI v5 Documentation does not get generated 【发布时间】:2021-12-09 18:40:53 【问题描述】:

我正在使用带有故事书的 Material UI V5,除了文档不会自动生成之外,一切似乎都很好。当我单击“文档”选项卡时,它只是一个空白屏幕。

我查看了这个使用 Material Ui V4 的存储库,并且有文档正在努力查看我是否可以找出哪里/如果我出错了。但没有铁砧。 Storybook MUI v4

我没有做任何花哨的事情,我所做的只是使用sb 命令行工具安装故事书,安装 Material UI v5 并导出一个按钮。但是没有文档显示。

import React from "react";
import PropTypes from "prop-types";
import MiButton from "@mui/material/Button";

export const Button = ( primary, backgroundColor, size, label, ...props ) => 
  return <MiButton>GOT IM!</MiButton>;
;

Button.propTypes = 
  primary: PropTypes.bool,
  backgroundColor: PropTypes.string,
  size: PropTypes.oneOf(["small", "medium", "large"]),
  label: PropTypes.string.isRequired,
  onClick: PropTypes.func,
;

Button.defaultProps = 
  backgroundColor: null,
  primary: false,
  size: "medium",
  onClick: undefined,
;

【问题讨论】:

【参考方案1】:

在 Storybook 存储库上发布错误报告后,发现 Storybooks 版本的情感和 Material Ui v5 版本的情感存在冲突。

有一种解决方法可以让文档使用 Mui5,直到他们解决将以下代码添加到 preview.js 的问题

export const parameters = 
  actions:  argTypesRegex: "^on[A-Z].*" ,
  layout: "centered",
  controls: 
    matchers: 
      color: /(background|color)$/i,
      date: /Date$/,
    ,
  ,
  docs: 
    inlineStories: false,
    iframeHeight: "700px",
  ,

【讨论】:

链接到 Storybook repo 上创建的错误报告不是很有趣吗?

以上是关于未生成 Storybook MUI v5 文档的主要内容,如果未能解决你的问题,请参考以下文章

Storybook 5 Sass-loader 生成空模块类名

@storybook/addon-controls:如何不为某个道具自动生成控件

如何在 Material-UI V5 (@mui/lab) datepicker 组件上设置一个空标签?

MUI v5 使用 styled() 将道具传递给 CSS 主题

js依赖mui.css生成图片验证码

readOnly MobileDatePicker 在 MUI v5 中不起作用