安装 react-styleguidist,创建 React 应用程序,使用 Typescript,Material UI 和 styled-components。
创始人
2024-08-27 00:30:05
0

以下是使用 React、Typescript、Material UI 和 styled-components 创建应用程序并安装 react-styleguidist 的步骤和示例代码:

步骤 1:创建 React 应用程序

首先,确保已经安装了 Node.js 和 npm。

运行以下命令创建一个新的 React 应用程序:

npx create-react-app my-app --template typescript
cd my-app

步骤 2:安装 Material UI 和 styled-components

运行以下命令来安装 Material UI 和 styled-components:

npm install @mui/material @emotion/react @emotion/styled styled-components

步骤 3:安装 react-styleguidist

运行以下命令来安装 react-styleguidist:

npm install --save-dev react-styleguidist

步骤 4:配置 react-styleguidist

在项目根目录下创建一个名为 .styleguidistrc.js 的文件,并添加以下内容:

module.exports = {
  components: 'src/components/**/[A-Z]*.tsx',
  defaultExample: true,
  styleguideDir: 'dist/styleguide',
  propsParser: require('react-docgen-typescript').withCustomConfig(
    './tsconfig.json',
    {
      propFilter: (prop) => {
        if (prop.parent) {
          return !prop.parent.fileName.includes('node_modules');
        }
        return true;
      },
    },
  ).parse,
  webpackConfig: {
    module: {
      rules: [
        {
          test: /\.(ts|tsx)$/,
          exclude: /node_modules/,
          use: [
            {
              loader: 'babel-loader',
              options: {
                presets: ['@babel/preset-env', '@babel/preset-react'],
              },
            },
            {
              loader: 'ts-loader',
            },
          ],
        },
        {
          test: /\.(css|scss)$/,
          use: ['style-loader', 'css-loader', 'sass-loader'],
        },
      ],
    },
    resolve: {
      extensions: ['.js', '.jsx', '.ts', '.tsx'],
    },
  },
};

步骤 5:创建组件和文档

src/components 目录下创建一个名为 Button.tsx 的文件,并添加以下内容:

import React from 'react';
import styled from 'styled-components';
import { Button as MuiButton } from '@mui/material';

const StyledButton = styled(MuiButton)`
  /* 添加自定义样式 */
`;

interface ButtonProps {
  children: React.ReactNode;
}

export const Button: React.FC = ({ children }) => {
  return {children};
};

src/components 目录下创建一个名为 Button.styleguide.md 的文件,并添加以下内容:

# Button

按钮组件。

## 示例

```jsx
import { Button } from './Button';



步骤 6:运行 react-styleguidist

运行以下命令启动 react-styleguidist:

npx styleguidist server


在浏览器中打开 http://localhost:6060/,您将看到生成的组件文档。

希望这个示例对您有所帮助!

相关内容

热门资讯

揭秘几款!多乐够级辅助,wep... 揭秘几款!多乐够级辅助,wepoker透视脚本网页,系统教程(有挂分析)1、超多福利:超高返利,海量...
重大通报(德扑之星透明)外挂透... 重大通报(德扑之星透明)外挂透明挂辅助挂(黑科技)有挂网上靠谱(的确有挂)-哔哩哔哩是一款可以让一直...
重磅来袭!途游游戏辅助工具,h... 重磅来袭!途游游戏辅助工具,hhpkoer辅助器,详细教程(有挂秘笈)1、不需要AI权限,帮助你快速...
2024教程(德扑之星系统)外... 《2024教程(德扑之星系统)外挂透明挂辅助插件(黑科技)ai机器人(有挂详细)-哔哩哔哩》 德扑之...
来一盘!潮汕掌上娱破解,wpk... 来一盘!潮汕掌上娱破解,wpk软件是真的,普及教程(有挂头条)1、潮汕掌上娱破解系统规律教程、潮汕掌...
让我来分享经验(微扑克分析器)... 让我来分享经验(微扑克分析器)外挂透明挂辅助挂(黑科技)免费软件透明挂(有挂方略)-哔哩哔哩;1、点...
我来教大家!小闲川南宜宾辅助,... 我来教大家!小闲川南宜宾辅助,aapoker发牌逻辑,揭秘教程(有挂详细)1、下载好小闲川南宜宾辅助...
安装程序教程!榕城510k有挂... 安装程序教程!榕城510k有挂,红龙poker辅助器免费观看,必胜教程(有挂透明挂)暗藏猫腻,小编详...
推荐一款!小程序广东雀神智能插... 推荐一款!小程序广东雀神智能插件安装,wepoker免费钻石,必备教程(有挂规律)1、小程序广东雀神...
今日头条!枫叶辅助官网,fis... 今日头条!枫叶辅助官网,fishpoker透视底牌,切实教程(真的有挂)1、起透看视 枫叶辅助官网透...