2024年如何通过完善的工程化,从0到1手把手建立个人 react 组件库

本文聚焦于快速创建并部署个人的组件库,方便平时开发中将通用的组件抽出,也可用于简历上展示个人的组件成果~

组件库体验地址:components-library

在这里插入图片描述
关于以上内容,你是否好奇如何实现的,对于大多数项目,诸如:antd element-plus 等,这些都是通过自己编写 md 表格去自定义的,但是对于个人开发的组件库,这显然是不太行的,因为这需要耗费大量时间去编写不太高频的内容,所以这方面显然是要通过自动化的形式完成,这也是本组件库需要攻克的重点!

关于上图内容其实只需要下面4行内容即可,是不是很震惊 😱

## Disabled Calendar<code src="src/compoents/Calendar/demo/index.tsx" />## Calendar Props<Props src="src/compoents/Calendar.tsx" />

一、快速初始化项目

目前市面上已经有很多项目格式化规范教程,这里就不再赘述了

这里直接可以使用npx @winches/ts-start@latest可以选择 react-components-library模版即可使用该模版

组件库的技术栈为: react + tailwindcss + rspress + vite + tsup

✨ 其次还可以学习到组件库工程化内容/插件/playground的编写

🌟 模版亮点

模版基于 rspress 实现了一套插件自动生成组件预览组件API文档,只需要注意编写的格式即可

🛠️ 插件系统

通过rspress集成的remark插件系统,开发了组件API自动生成插件,提升个人开发的效率,感兴趣的可以查看源码实现

路径位于:docs/plugins/generate-props.ts

支持:

  1. Mdx 文件 Props 组件自动生成组件 API
  2. 跳转到组件源码

📻 playground 组件开发

关于组件库的开发肯定少不了组件预览,所以也实现了一套可以快速开发的工程

只需要在开发的组件下创建demo目录,随后在该目录下创建xxx.tsx文件

最后你就可以运行playground下的dev指令,它会自动抓取你demo目录下的文件到plaryground下,随后可以通过浏览器路由的方式查看你正在开发的组件

demo下的组件也可以用于docs中文档的展示,极大减少开发者的工作

关于该内容的实现:

路径:playground/app.init.ts playground/main.tsx

🤖 组件库的详细用法

Note:有需要自取,下面的内容属于组件库的详细用法介绍

1. 组件开发/预览

Playground 查看并开发组件

一、使用

playground 目录下直接运行 pnpm dev,会将 app.example.tsx 生成到 src 目录下

随后可以直接在 src/App.tsx 中修改你想要调试的组件代码

二、添加其他测试组件页面

src 目录下,添加新文件 Test.tsx,自动添加该组件到 /test 路由下

通过 http://localhost:<port>/test 路由可以访问到该组件

三、自动获取components/**/demo下的文件到playground

可以通过组件名直接访问并进行开发

http://localhost:<port>/<component>/<demoName>

e.g. http://localhost:5173/calendar/usage

2. 自动生成组件文档

一、使用

docs 目录下直接运行 dev

二、组件预览

通过下面在mdx中引入code组件即可实现组件预览

代码:
<code src="src/compoents/Calendar/demo/index.tsx />

src 相对根目录的路径

三、组件属性预览

通过下面在mdx中引入Props组件即可实现组件属性自动转换成 markdown

代码:
<Props src="src/compoents/Calendar.tsx" />

Props 组件属性

1、src 指定要解析的组件文件地址,输入相对根目录的路径

2、hideJumpButton 隐藏跳转到源码按钮,默认false

3、component 默认选择第一个export的组件,若存在多个组件,则需要通过传component指定对应的组件,或者通过组件文件内定义displayName指定组件

// Way 1
// component 指定,当存在多个 export 组件时
<Props src="src/compoents/Calendar.tsx" component="Calendar" />//  Calendar.tsx
export const Calendar = memo(CalendarComponent)// Way 2
//  Calendar.tsx
export const Calendar = memo(CalendarComponent)
// displayName 指定 Calendar 组件
Calendar.displayName = 'Calendar'

组件文档使用演示:

## Disabled Calendar<code src="src/compoents/Calendar/demo/index.tsx" />## Calendar Props<Props src="src/compoents/Calendar.tsx" />

生成的效果图如图:

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/24609.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【C语言】预处理详解(上卷)

前言 预处理也是C语言中非常重要的存在。那么就详细地来了解一下吧。 预定义符号 C语言设置了一些预定义符号&#xff0c;可以直接使用&#xff0c;预定义符号也是在预处理期间处理的。 1 __FILE__ //进行编译的源文件 2 __LINE__ //文件当前的…

JavaSE——抽象类和接口

目录 一 .抽象类 1.抽象类概念 2.抽象类语法 3.抽象类特性 4.抽象类的作用 二. 接口 1.接口的概念 2.语法规则 3.接口的使用 4.接口特性 5.实现多个接口 6.接口间的继承 三.抽象类和接口的区别 一 .抽象类 1.抽象类概念 在面向对象的概念中&#xff0c;所有的对…

python -- series和 DataFrame增删改数据

学习目标 知道df添加新列的操作 知道insert函数插入列数据 知道drop函数删除df的行或列数据 知道drop_duplicates函数对df或series进行数据去重 知道unique函数对series进行数据去重 知道apply函数的使用方法 1 DataFrame添加列 注意:本文用到的数据集在文章顶部 1.1 直…

微信小程序 map

组件 地图个性化样式组件是腾讯位置服务为开发者提供的地图高级能力&#xff0c;开发者可以在法律允许的范围内定制地图风格&#xff0c;支持定制背景面、背景线、道路、POI等地图元素颜色、显示层级等内容&#xff1b;支持按照类型精细化管理POI的显示、隐藏&#xff1b;灵活…

JMS VS AMQP

JMS&#xff08;Java Message Service&#xff09;是一个为Java平台设计的API&#xff0c;主要针对Java开发者提供了一套用于企业级消息服务的标准接口。而AMQP&#xff08;Advanced Message Queuing Protocol&#xff09;是一个应用层协议&#xff0c;它提供了一个开放的、标准…

BUG解决: Zotero 文献GBT7714无法正常调用

1. 下载csl文件 网上有推荐直接下载现成版本的&#xff0c;比如参考资料【1】的蓝奏云文件&#xff0c;但是还是无法实现功能&#xff08;空文档中可以用了&#xff09;。 2. Github版本 也有说网盘版本和那个 Juris-M 的 CSL bug 太多的。 总结 后面发现&#xff0c;只需…

带池化注意力 Strip Pooling | Rethinking Spatial Pooling for Scene Parsing

论文地址:https://arxiv.org/abs/2003.13328 代码地址:https://github.com/houqb/SPNet 空间池化已被证明在捕获像素级预测任务的长距离上下文信息方面非常有效,如场景解析。在本文中,我们超越了通常具有N N规则形状的常规空间池化,重新思考空间池化的构成,引入了一种…

对比深度图聚类的硬样本感知网络

Hard Sample Aware Network for Contrastive Deep Graph Clustering 文章目录 Hard Sample Aware Network for Contrastive Deep Graph Clustering摘要引言方法实验结论启发点 摘要 本文提出了一种名为Hard Sample Aware Network (HSAN)的新方法&#xff0c;用于对比深度图聚类…

Git+Gitlab 远程库测试学习

Git远程仓库 1、Git远程仓库 何搭建Git远程仓库呢&#xff1f;我们可以借助互联网上提供的一些代码托管服务来实现 Gitee 码云是国内的一个代码托管平台&#xff0c;由于服务器在国内&#xff0c;所以相比于GitHub&#xff0c;码云速度会更快 码云 Gitee - 基于 Git 的代码托…

Python实现连连看9

&#xff08;2&#xff09;标识选中的图片 在判断出玩家选中的是哪一张图片之后&#xff0c;接下来就可以标识选中的图片了&#xff0c;即在该选中的图片外围画矩形。代码如下所示。 FIRSTCLICK True #FIRSTCLICK是全局变量 if(click_col>0 and click_row>0) and \(no…

【进程调度的基本过程】初步认识进程和线程的区别与联系:计算机是如何工作的

​ &#x1f525;个人主页&#xff1a; 中草药 &#x1f525;专栏&#xff1a;【Java】登神长阶 史诗般的Java成神之路 &#x1f43a;一.冯诺依曼体系结构 认识计算机的祖师爷 -- 冯诺依曼 冯诺依曼&#xff08;John von Neumann&#xff0c;1903年12⽉28⽇-1957年2⽉8⽇&…

调用华为API实现语音合成

目录 1.作者介绍2.华为云语音合成2.1 语音合成介绍2.2 华为语音合成服务2.3 应用场景 3. 实验过程以及结果3.1 获取API密钥3.2 调用语音合成算法API3.3 实验代码3.4 运行结果 1.作者介绍 袁斌&#xff0c;男&#xff0c;西安工程大学电子信息学院&#xff0c;2023级研究生 研究…

SpringBoot整合Skywalking

下载Java Agent 官网&#xff1a;https://skywalking.apache.org/downloads/ 提示&#xff1a;Agent最好到网上找一找之前的版本&#xff0c;新版本可能有bug&#xff0c;如果出现了并且网上也几乎没有这个版本的解决方法那么就切换之前的版本 本地启动时 -javaagent:d:\opt\…

建筑特种工高处作业吊篮安装拆卸工题库

1、施工现场外租吊篮设备&#xff0c;在施工前应由( )编制专项施工方案&#xff0c;并由( )技术负责人和现场总监理工程师签字后实行。 A 使用单位 使用单位 B 使用单位 租赁单位 C 租赁单位 使用单位 D 租赁单位 租赁单位 2、施工现场外租吊篮…

java基础语法整理 ----- 上

java基础语法 一、变量二、数据类型三、标识符四、键盘录入五、判断语句1. 三种格式2. 练习题 六、switch语句七、循环八、循环控制语句九、方法 一、变量 1.什么是变量&#xff1a; 在程序运行过程中&#xff0c;其值可以发生改变的量从本质上讲&#xff0c;变量是内存中的一…

MineAdmin 前端打包后,访问速度慢原因及优化

前言&#xff1a;打包mineadmin-vue前端后&#xff0c;访问速度很慢&#xff0c;打开控制台&#xff0c;发现有一个index-xxx.js文件达7M&#xff0c;加载时间太长&#xff1b; 优化&#xff1a; 一&#xff1a;使用文件压缩&#xff08;gzip压缩&#xff09; 1、安装compre…

java基础练习题

1、一个".java"源文件中是否可以包括多个类&#xff1f;有什么限制&#xff1f; 可以包含多个类。但是只有一个类可以声明为public&#xff0c;且要求声明为public的类的类名与源文件名相同。 2、java的优势&#xff1f; a、跨平台性 b、安全性高 c、简单性 d、…

无延迟,持续畅玩 - Wi-Fi 6 助力打造游戏厅极致体验

1、需求背景&#xff1a; 连锁游戏厅行业竞争激烈&#xff0c;顾客对高品质的游戏体验有着高要求。网络是游戏厅的核心基础设施之一&#xff0c;需要确保游戏过程中的网络连接稳定性和顾客满意度。 长时间稳定连接 为保证顾客的游戏体验感&#xff0c;游戏厅要确保网络连接长…

使用 CloudFlare Turnstile 解决跨境电商站的垃圾邮件侵扰

最近明月一个跨境电商代维客户的网站被垃圾邮件侵扰了,从最开始的每天几封疯狂到每天几百上千封垃圾邮件,几乎所有可拦截屏蔽的关键词都是随机可变的,简单的邮件客户端拦截基本已经没有任何效果了,在收到用户的求助后经过分析发现主要是利用网站在线咨询页面里的邮件发送造…

SMS-GSM

SMS-GSM 短信模块&#xff0c;不想通过第三方的接口&#xff0c;自己搭建短信模块&#xff0c;提高信息安全。 /**/ package sms;import com.diagcn.smslib.CMessage; import com.diagcn.smslib.COutgoingMessage; import com.diagcn.smslib.SZHTOCService;/*** 短信模块** au…