文档导航

欢迎来到 UOZI Admin 文档！本页面将帮助你快速找到所需的信息。

🗺️ 学习路径

🌟 新手入门（推荐顺序）

1. 框架总览 - 了解整体架构和核心理念
2. 入门指南 - 从零开始的完整教程
3. CLI 工具 - 学会使用脚手架工具
4. Request 库 - 掌握 API 层的使用
5. CRUD 组件 - 构建数据管理页面

🔧 进阶开发

1. 布局系统 - 自定义页面布局
2. 表单控件 - 丰富的表单组件
3. 自定义渲染 - 高级定制功能
4. 全局配置 - 统一配置管理
5. 国际化 - 多语言支持

🎯 专业开发

1. 项目结构 - 最佳实践
2. 共享配置 - 开发工具配置
3. 高级特性 - 自定义组件

📚 文档分类

🛠️ 开发工具

包名	描述	快速开始
create-uozi-admin	项目脚手架	CLI 快速开始
@uozi-admin/shared-config	共享配置	配置快速开始

🎨 UI 组件

包名	描述	快速开始
@uozi-admin/layout-antdv	布局组件	布局快速开始
@uozi-admin/curd	CRUD 组件	CRUD 快速开始

🌐 数据层

包名	描述	快速开始
@uozi-admin/request	HTTP 请求库	Request 快速开始

🔍 按功能查找

项目创建和配置

• 创建新项目
• 项目结构说明
• Vite 配置
• 插件配置

API 和数据管理

• HTTP 请求
• CRUD 接口
• 扩展 API
• 请求拦截器

页面和组件

• CRUD 页面
• 表格组件
• 表单组件
• 搜索组件
• 详情组件

表单控件

• 输入框
• 选择器
• 日期选择
• 数字输入
• 开关
• 更多控件...

布局和主题

• 布局组件
• 应用配置
• 主题定制
• 国际化

高级功能

• 列定义
• 自定义渲染
• 自定义表单控件
• 全局配置
• 国际化

🎯 常见场景

我想要...

创建一个新项目 → CLI 快速开始

构建用户管理页面 → 入门指南 → CRUD 快速开始

自定义表格列显示 → 列定义 → 自定义渲染

添加搜索功能 → 搜索配置 → 搜索组件

自定义表单字段 → 表单配置 → 表单控件

配置 API 接口 → Request 快速开始 → API 配置

自定义页面布局 → 布局快速开始 → 布局组件

支持多语言 → CRUD 国际化 → 布局国际化

优化开发体验 → 共享配置 → Vite 配置

📖 文档约定

代码示例

• 所有示例都基于 TypeScript
• 使用 ~/ 表示 src/ 目录
• 使用 Vue 3 Composition API

链接说明

• 🔗 内部链接指向本文档的其他页面
• 🌐 外部链接指向 GitHub 或其他网站
• 📁 文件路径使用等宽字体

图标含义

• 🚀 快速开始
• 🔧 配置相关
• 🎨 UI 和样式
• 📚 详细文档
• ⚠️ 注意事项
• 💡 提示和技巧

🤝 贡献文档

发现文档问题或想要改进？

• 📝 编辑此页面
• 🐛 报告问题
• 💬 参与讨论

---

找不到你需要的信息？ 请查看 框架总览 或 入门指南。