os-micro-frontend-shared
用于Tap Payments微前端的共享React组件库
这是什么?
一个全面的React组件库提供:
- 100+ UI组件 (按钮、表格、对话框、表单、过滤器)
- 18个定制钩子 (烤面包,窗口尺寸,主题模式)
- 47个实用模块 (日期/货币格式,验证)
- 完整的TypeScript支持 使用类型定义
- MUI-based主题 具有暗/亮模式和RTL/LTR支持
- 高性能虚拟表 对于大型数据集
快速入门
npm install @tap-payments/os-micro-frontend-shared
# or
yarn add @tap-payments/os-micro-frontend-shared
import { Button, VirtualTable, useToast } from '@tap-payments/os-micro-frontend-shared'
function MyApp() {
const toast = useToast()
return (
<Button variant="primary" onClick={() => toast.success('Hello!')}>
Click me
</Button>
)
}
文档
📚 完整文档→
| 文档 | 描述 | 阅读时间 |
|---|---|---|
| 概述 | 功能、包规格、特性 | 15分钟 |
| 设置和堆栈 | 安装、命令、工作流 | 10分钟 |
| 体系结构 | 布局,导出,模块边界 | 15分钟 |
| 组件指南 | 用示例对所有组件进行分类 | 参考 |
| 组件开发 | 构建新组件 | 20分钟 |
关键特性
- ✅ ESM-only -现代模块系统与树摇
- ✅ 同行依赖性 —避免版本冲突
- ✅ 完整的打印稿 -完全型安全
- ✅ 100 +组件 -全面的UI库
- ✅ 虚拟表 -高性能列表
- ✅ React Hook表单 -集成表单组件
- ✅ 主题 -暗/亮模式,RTL/LTR
- ✅ memoize的 -优化性能
开发
# Install dependencies
yarn install
# Start dev server
yarn dev
# Build library
yarn build
# Test locally in another project
yarn push:local # requires yalc
看到 安装指南 详细说明。
出版
自动化(推荐)
将PR合并到 main 自动:
- 补丁版本
- 提交版本变更
- 构建图书馆
- 向npm发布
版本提交使用该格式 chore(release): vX.Y.Z.
查找已发布版本的提交:
git log --oneline --grep="release: vX.Y.Z"
手册
# Test version (with -test tag)
yarn push:test
# Production
yarn push
看到 出版 获取详细信息。
贡献
- 创建特性分支
- 进行更改
src/ - 运行
yarn lint:fix和yarn prettier:fix - 提交(预提交钩子将运行)
- 推动和创建公关
main
看到 开发 详细指南。
项目结构
src/
├── components/ # 100+ React components
├── hooks/ # 18 custom React hooks
├── utils/ # 47 utility modules
├── types/ # TypeScript type definitions
├── constants/ # App constants and configs
└── theme/ # MUI theme configuration
看到 文件夹/模块结构 获取详细信息。
技术堆栈
- React 18 + TypeScript 5
- MUI(材质- ui) 5 +情感
- React Hook Form +是的
- Vite 6(构建+开发)
- ESLint + Prettier
看到 技术堆栈 查看完整的列表。
许可证
麻省理工学院© 利用支付
链接
支持
有关问题、问题或贡献,请参阅 文档 或者制造一个问题。