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进行文档编写和组件展示。开发者可以根据自己的需求进一步扩展和定制。

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日