React UI Library

一个现代化的 React UI 组件库，基于 React + TypeScript + Vite 构建。

特性

• 🚀 基于 React 19 和 TypeScript 5.7
• 📦 使用 Vite 6.2 构建，开发体验极佳
• 📚 完整的 TypeScript 类型支持
• 🔍 Storybook 组件预览和文档, 测试
• 📝 VitePress 文档站点

安装

npm install @yuqi_dev/react-ui-library
# 或者
yarn add @yuqi_dev/react-ui-library
# 或者
pnpm add @yuqi_dev/react-ui-library

快速开始

import { Button } from '@yuqi_dev/react-ui-library'

function App() {
  return (
    <Button type="primary">点击我</Button>
  )
}

文档

访问我们的在线文档了解更多信息。

本地开发

1. 克隆仓库

git clone <repository-url>
cd react-ui-library

2. 安装依赖

pnpm install

3. 启动开发服务器

# 启动组件库开发环境
pnpm dev

# 启动 Storybook
pnpm storybook

# 启动文档站点
pnpm docs:dev

构建

# 构建组件库
pnpm build

# 构建文档站点
pnpm docs:build

# 构建 Storybook
pnpm build-storybook

目录结构

├── src/               # 组件源码
├── docs/              # 文档
├── stories/           # Storybook 测试示例
└── vite.config.ts     # Vite 配置

技术栈

• React 19
• TypeScript 5.7
• Vite 6.2
• Storybook 8.6
• VitePress 1.6

贡献指南

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
3. 提交你的改动 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启一个 Pull Request

许可证

ISC