1react+dumi+typescript搭建组件库开发环境

以下是一个使用React, dumi和TypeScript搭建组件库的基本步骤和示例代码:

  1. 初始化项目:



npx create-react-app my-component-library --template typescript
cd my-component-library
  1. 添加dumi支持:



npm install --save-dev dumi
  1. 修改package.json,添加dumi脚本:



{
  "scripts": {
    "start": "dumi dev",
    "build": "dumi build",
    "preview": "dumi preview"
  }
}
  1. 创建组件文件,例如Button.tsx



import React from 'react';
 
export type ButtonProps = {
  label: string;
  onClick: () => void;
};
 
const Button: React.FC<ButtonProps> = ({ label, onClick }) => (
  <button onClick={onClick}>{label}</button>
);
 
export default Button;
  1. 创建dumi配置文件.umirc.ts



export default {
  mfsu: {},
  theme: {
    // 自定义主题配置
  },
  // 其他dumi配置
};
  1. 创建组件的API文档,在docs/button.mdx



import { Button } from '../src/Button';
 
# Button
 
A simple button component.
 
## Usage
 
```jsx
import React from 'react';
import { Button } from 'my-component-library';
 
export default () => <Button label="Click Me" onClick={() => alert('Clicked!')} />;



 
7. 启动dumi开发服务器:
```bash
npm start
  1. 构建组件库:



npm run build
  1. 预览构建结果:



npm run preview

以上步骤和代码示例展示了如何使用React和TypeScript搭建一个简单的组件库,并使用dumi进行文档编写和组件展示。开发者可以根据自己的需求进一步扩展和定制。

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日