sum-react
v0.6.0
Published
基于 React 的业务组件库
Downloads
8
Readme
PC 端 React 组件库基本框架
一、业务组件库产生背景
在实际项目中,同一条业务线一般都有自己的一套规范,这套规范可能是基于 antd 等通用 UI 组件的改造,很多时候业务场景都是相似的,为保证多个项目的通用组件统一视觉和交互,因此根据实际业务场景,抽出通用组件形成业务组件库就很有必要,同时也更容易维护。
二、技术栈
基于 react + antd 根据统一设计规范抽出业务通用组件库文档站基于 react-styleguildist + webpack 最终的业务组件用 rollup 打包
三、业务组件开发原则
低耦合、模块化、可复用
四、开发组件&文档
安装依赖
yarn install
or
npm install
调试、开发组件库启动文档服务
yarn doc
or
npm run doc
组件开发
新组件以文件夹形式统一放到 components
下,最终在 components
下的 index.js
文件中导出
利用 plop 工具快速生成组件文件夹,会根据模板文件生成以组件命名的文件夹,同时修改components
下的 index.js
yarn plop <ComponentName>
or
npx plop <ComponentName>
提交规范
yarn commit
or
npm run commit
commit 提交规范步骤提示
文档打包
yarn build_doc
or
npm run build_doc
可以打包后部署到 github pages 上 戳这里看 添加 GitHub Actions 持续集成 提交自动部署
五、组件库打包
yarn build
or
npm run build
说明:打包的时候会出现 antd 依赖循环引用的报错: https://github.com/ant-design/ant-design/pull/23800 已有 pr 但是截止 2020.12.09 的最新 4.9.2 版本并没有解决这个问题
六、发布前准备
- 首先确保已经登录 npm 账号并且拥有发布权限
- 生成版本号、打 tag 和生成更改日志,其他用法详情见standard-version
yarn release -- --release-as <版本号>
# Or
npm run release -- --release-as <版本号>
成功之后把 tag 推到远程
git push --follow-tags origin master
七、发布到 npm
如果之前没有登录过 npm 的话,需要先登录再执行发布命令。放到 npm scripts 里 pub 命令,其实就是打包和发布的组合命令,执行发布之前先打包文档部署。或者不想要部署文档就直接执行发布命令好了
yarn pub
or
npm run pub
八、组件库使用
- 确保项目安装了
antd
react
react-dom
- 直接 npm 安装使用包
tips: rollup 打包已经实现按需引入,无需引入插件
体验 demo
安装 npm 包
yarn add sum-react
or
npm install sum-react
组件里使用
import React from 'react';
import { BaseButton, BaseModal } from 'sum-react'
function App() {
const [visible, setVisible] = React.useState(false);
const showModal = () => {
console.log('showmodal');
setVisible(true);
};
const closeModal = () => {
console.log('closemodal');
setVisible(false);
}
return (
<div className="App">
<header className="App-header">
<img src={logo} className="App-logo" alt="logo" />
<BaseButton onClick={showModal}>点击我展示弹窗</BaseButton>
<BaseModal title="Basic Modal" visible={visible} onOk={closeModal} onCancel={closeModal}>
<p>Some contents...</p>
</BaseModal>
</header>
</div>
);
}
export default App;
单元测试
yarn test
or
npm run test
九、TODO
- [x] 文档示例
- [x] 更改日志
- [x] 文档部署
- [x] 快速新建组件文件夹
- [x] 按需引入
- [x] 单元测试
- [ ] 组件埋点