0

0

轮子系列:使用vite从零开发React组件库

看不見的法師

看不見的法師

发布时间:2025-09-08 08:18:18

|

560人浏览过

|

来源于php中文网

原创

前言

新年伊始,与团队的小伙伴们开启了一系列造轮子的项目 - 如何打造一个组件库。

Boty-Design首先,组件库需要一个响亮的名称 -> Boty-Design。

Vite最近推出了Vite2,支持React开发,我们选择Vite作为组件库的开发工具。

轮子系列:使用vite从零开发React组件库如上图所示,Vite开发环境的构建速度远超传统的Webpack,这也是我们选择Vite进行组件库开发的主要原因。

dumi由于Vite缺乏优秀的文档工具,我们并不需要为所有功能自己造轮子,因此我们选择了dumi作为文档工具集成到项目中。

dumi配置由于我们并未使用umi,我们采用了官方推荐的第三方使用方法。

代码语言:javascript代码运行次数:0运行复制```javascript // 安装模块。yarn add dumi cross-env -D// 增加启动命令,修改 package.json。 "scripts": { "dumi": "cross-env APP_ROOT=dumi dumi dev", "dumi-build": "cross-env APP_ROOT=dumi dumi build" },// 增加配置,新建 config/config.js。export default { chainWebpack(memo) { memo.plugins.delete('copy'); },};

新建文档目录 dumi/docs/,这里的 dumi 目录即启动命令的环境变量 APP_ROOT,你可以随意同步修改。

新建文档 dumi/docs/index.md,后续即可根据 dumi 的文档进行正常的 doc 开发。

组件 API 自动生成dumi 可以通过 JS Doc 注解 + TypeScript 类型定义的方式来自动生成组件的API。

代码语言:javascript代码运行次数:0http://www.w3.org/2000/svg"> d="M6.66666 10.9999L10.6667 7.99992L6.66666 4.99992V10.9999ZM7.99999 1.33325C4.31999 1.33325 1.33333 4.31992 1.33333 7.99992C1.33333 11.6799 4.31999 14.6666 7.99999 14.6666C11.68 14.6666 14.6667 11.6799 14.6667 7.99992C14.6667 4.31992 11.68 1.33325 7.99999 1.33325ZM7.99999 13.3333C5.05999 13.3333 2.66666 10.9399 2.66666 7.99992C2.66666 5.05992 5.05999 2.66659 7.99999 2.66659C10.94 2.66659 13.3333 5.05992 13.3333 7.99992C13.3333 10.9399 10.94 13.3333 7.99999 13.3333Z" fill="currentcolor">运行http://www.w3.org/2000/svg"> clip-rule="evenodd" d="M4.5 15.5V3.5H14.5V15.5H4.5ZM12.5 5.5H6.5V13.5H12.5V5.5ZM9.5 2.5H3.5V12.5H1.5V0.5H11.5V2.5H9.5Z" fill="currentcolor" fill-rule="evenodd">复制

javascript interface BaseProps {  /**   * @description 自定义样式名   */  className?: string;  /**   * @description 自定义样式   */  style?: React.HTMLProps;}// dumi.md 使用

由于我们这次基本都是用 TypeScript 开发,非常轻松就可以利用 dumi 的这个功能生成我们想要的 API,如下图:

轮子系列:使用vite从零开发React组件库dumi github action + github page在项目根路径新建 .github/workflows/gh-pages.yml 文件。

代码语言:javascript代码运行次数:0运行复制javascript name: github pageson: push: branches: - master # default branchjobs: deploy: runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v2 - run: yarn install - run: yarn run dumi-build - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./dumi/dist

后续合并到 master 分支时会触发 action 自动构建,选择生成好的静态分支目录即可发布到 github page。

可能遇到的问题config/config.js 不生效由于你的启动命令已经指定了 APP_ROOT,也就是修改了运行路径,所以把 config 也放在 APP_ROOT 指定路径下。

dumi 在 Windows 下构建失败这个暂时无解,生成静态文件的路径格式在 Windows 下不合法,直接在 Linux 或者 macOS 上构建是正常的,所以用 GitLab Action 是可以的。

别名不生效修改 config/config.js 或者 .umirc.ts。

代码语言:javascript代码运行次数:0http://www.w3.org/2000/svg"> d="M6.66666 10.9999L10.6667 7.99992L6.66666 4.99992V10.9999ZM7.99999 1.33325C4.31999 1.33325 1.33333 4.31992 1.33333 7.99992C1.33333 11.6799 4.31999 14.6666 7.99999 14.6666C11.68 14.6666 14.6667 11.6799 14.6667 7.99992C14.6667 4.31992 11.68 1.33325 7.99999 1.33325ZM7.99999 13.3333C5.05999 13.3333 2.66666 10.9399 2.66666 7.99992C2.66666 5.05992 5.05999 2.66659 7.99999 2.66659C10.94 2.66659 13.3333 5.05992 13.3333 7.99992C13.3333 10.9399 10.94 13.3333 7.99999 13.3333Z" fill="currentcolor">运行http://www.w3.org/2000/svg"> clip-rule="evenodd" d="M4.5 15.5V3.5H14.5V15.5H4.5ZM12.5 5.5H6.5V13.5H12.5V5.5ZM9.5 2.5H3.5V12.5H1.5V0.5H11.5V2.5H9.5Z" fill="currentcolor" fill-rule="evenodd">复制```javascript chainWebpack(memo) { memo.module .rule('js') .test(/.(js|mjs|jsx|ts|tsx)$/) .include.add(join(__dirname, '..', '..', 'src/components')).end() .exclude.add(/node_modules/).end() .use('babel-loader') }, alias: { 'boty': join(__dirname, '..', '..', 'src/components'), },

配置完成后可以正常在 dumi 的 md 文件中使用别名。

开始启航前期准备工作已经基本完成,接下来就进行一轮造轮子的工程。

陌言AI
陌言AI

陌言AI是一个一站式AI创作平台,支持在线AI写作,AI对话,AI绘画等功能

下载

这里首先感谢 Ant Design 团队,我们的轮子的设计与部分内容都是参考(借鉴)了业内专业的 Ant Design。

第一个组件 Button刚开始肯定不能选择最难的,否则做不出来就容易放弃。

因此选择 button 组件来练手(其实内容也不少 = =!),先分析一下 button 的功能。

轮子系列:使用vite从零开发React组件库其实大体就是自定义样式、功能与预设样式、功能。

我们在里面加入了一些贴合业务的功能,比如当 loading 存在时,与 antd 的设计不同,不是由开发者去开启、关闭 loading 的状态,而是直接将 click 方法作为异步函数,点击时就开启 loading 状态,等待回调结束会关闭 loading 状态。

为什么要造轮子距离上一次我造轮子,大概过去了 5 年,也是根据 VUM1.0 去改造的升级版本,当时的作者言川大佬在 vue2 出来的时候,没有抽得出空来更新 VUM 这个 vue 移动端组件库,而我是 Vue 的初学者,本着更深入学习的想法,就将 VUM 从 vue1 升级到 vue2。虽然那个时候很忙,但是收获还是蛮多也挺开心的。

这一次的轮子也不是从零开发,毕竟我们站在了 AntD 这个巨人的肩膀上,可以看得更远。

在这个项目中,除了技术之外,更多的可能是从设计、产品的角度来打磨这套产品。

同时也希望这个项目能对一些同学有一定的帮助。

写在最后项目介绍项目地址

项目预览地址

我们会反复修改一些细节部分,有想追的朋友可以 star 一下。

项目成员清尘 - 负责样式serializedowen - 负责PUACookieBoty - 负责打杂

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

557

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

394

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

754

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

478

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

454

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

1031

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

658

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

554

2023.09.20

AO3中文版入口地址大全
AO3中文版入口地址大全

本专题整合了AO3中文版入口地址大全,阅读专题下面的的文章了解更多详细内容。

1

2026.01.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel5.7框架视频教程
Laravel5.7框架视频教程

共21课时 | 3.8万人学习

布尔教育git快速入门视频教程
布尔教育git快速入门视频教程

共10课时 | 3万人学习

后盾网HTML5视频教程
后盾网HTML5视频教程

共38课时 | 8.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号