当前位置:

首页 > 软件教程 > 轮子系列:Vite搭建React组件库教程

轮子系列:Vite搭建React组件库教程

前言新年伊始,与团队的小伙伴们开启了一系列造轮子的项目-如何打造一个组件库。Boty-Design首先,组件库需要一个响亮的名称->Boty-Design。Vite最近推出了Vite2,支持React开发,我们选择Vite作为组件库的开发工具。如上图所示,Vite开发环境的构建速度远超传统的Webpack,这也是我们选择Vite进行组件库开发的主要原因。dumi由于Vite缺乏优秀的文档工具,我们并不需要为所有功能自己造轮子,因此我们选择了dumi作为文档工具集成到项目中。dumi配置由于我

本文目录

    前言

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

    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 文件中使用别名。

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

    这里首先感谢 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 - 负责打杂

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    软件教程 GitHub
    相关文章 更多
    GPT-6.2 Astra 与 GPT-6.2 Sol 在 GitHub Copilot 为什么可能暂时看不到?
    GPT-6.2 Astra 与 GPT-6.2 Sol 在 GitHub Copilot 为什么可能暂时看不到?

    GPT-6.2 Astra 与 GPT-6.2 Sol 在 GitHub Copilot 正式开放,覆盖 Pro+、Max、Business 和 Enterprise,客户端逐步推送并受组织模型策略约束。

    GitHub Copilot 管理员怎样控制 MAI Code 2 与 MAI Code 2 Flash?
    GitHub Copilot 管理员怎样控制 MAI Code 2 与 MAI Code 2 Flash?

    GitHub Copilot 新增 MAI Code 2 与 MAI Code 2 Flash。 组织可以通过模型策略管理新模型。默认自动启用的行为,取决于管理员是否关闭全局默认或禁用具体模型。

    Copilot Fusion 的 Claude Sonnet 5.5、GPT-6.1 Terra、MAI-Code-2 能在手机使用吗?
    Copilot Fusion 的 Claude Sonnet 5.5、GPT-6.1 Terra、MAI-Code-2 能在手机使用吗?

    Copilot Fusion 新增 Claude Sonnet 5.5、GPT-6.1 Terra 和 MAI-Code-2。 手机入口的开放范围目前包括两类系统的测试版。正式移动应用的支持仍待后续开放。

    GitHub Copilot Evals 如何定位自定义配置的退化?
    GitHub Copilot Evals 如何定位自定义配置的退化?

    同一任务重复运行后,可以比较改动前后的结果和代理的处理过程,帮助定位需要调整的自定义配置。

    GitHub Copilot CLI 1.0.113 的 Entra 预览支持哪些系统?
    GitHub Copilot CLI 1.0.113 的 Entra 预览支持哪些系统?

    GitHub Copilot CLI 1.0.113 及以上。 这一登录预览目前支持两类桌面系统。开始使用之前,需要核对客户端版本,以及组织授予哪条模型访问路径。

    GitHub Copilot 更新后应使用哪个 JetBrains 版本?
    GitHub Copilot 更新后应使用哪个 JetBrains 版本?

    旧版开发环境的支持范围发生变化,部分新增能力也仍处于预览和分阶段开放状态。

    GitHub Copilot 接入 Microsoft Agent 365 后怎样理解活动和风险信息?
    GitHub Copilot 接入 Microsoft Agent 365 后怎样理解活动和风险信息?

    GitHub Copilot 活动可经企业审计流进入 Microsoft Agent 365,面向使用 Enterprise Managed Users 的 Enterprise Cloud 客户。

    GitHub Copilot app 1.2.0 的正式支持与预览集成如何区分?
    GitHub Copilot app 1.2.0 的正式支持与预览集成如何区分?

    GitHub Copilot app 1.2.0 及以上正式支持 GHES;Azure DevOps 与浏览器使用进入预览,分别说明账号、隔离和云会话限制。

    GitHub Copilot 自适应审查和密钥检测有哪些启用边界?
    GitHub Copilot 自适应审查和密钥检测有哪些启用边界?

    GitHub Copilot 代码审查新增 Adaptive 预览、密钥检测与仓库结果统计,分别说明默认值、上限、AI credits 以及读取权限。

    GitHub MCP Server v2.2.0 的技能、自动化与告警分别改变了什么?
    GitHub MCP Server v2.2.0 的技能、自动化与告警分别改变了什么?

    GitHub MCP Server v2.2.0 提供可选的过滤技能目录、代理自动化工具和秘密扫描告警隐藏参数。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。