feat(DOC): 完整地审查了代码,更完整的注释说明
- 未修改代码 - 统一了所有组件README的格式
This commit is contained in:
36
README.md
36
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
## 概述
|
||||
|
||||
KnowAI UI 是一个基于 Vue 3 和 TypeScript 的企业级 UI 组件库,专为 AI 应用场景设计。它提供了一套美观、易用、可定制的组件,帮助开发者快速构建现代化的 AI 应用界面。
|
||||
KnowAI UI 是一个基于 Vue 3 和 TypeScript 的企业级 UI 组件库,专为 AI 应用场景设计。它提供了一套美观、易用、可定制的组件,帮助开发者快速构建现代化的 AI 应用界面。采用 BEM规范 与风格-呈现两层模式组合的平衡架构,使 SCSS 足够规范与灵活。
|
||||
|
||||
## 模块分类
|
||||
|
||||
@@ -27,26 +27,26 @@ KnowAI UI 是一个基于 Vue 3 和 TypeScript 的企业级 UI 组件库,专
|
||||
组件模块提供丰富的 UI 组件,满足各种应用场景需求:
|
||||
|
||||
#### 基础组件
|
||||
- **Button** - 灵活的按钮组件,支持多种样式和状态
|
||||
- **Icon** - 丰富的图标系统,支持自定义和动态加载
|
||||
- **Text** - 文本组件,支持多种格式和样式控制
|
||||
- **Divider** - 分割线组件,用于内容分隔
|
||||
- **Avatar** - 头像组件,支持多种图片源和样式
|
||||
- **Tag** - 标签组件,用于内容分类和标记
|
||||
- **Image** - 图片组件,支持懒加载和错误处理
|
||||
- **KButton** - 灵活的按钮组件,支持多种样式和状态
|
||||
- **KIcon** - 丰富的图标系统,支持自定义和动态加载
|
||||
- **KText** - 文本组件,支持多种格式和样式控制
|
||||
- **KDivider** - 分割线组件,用于内容分隔
|
||||
- **KAvatar** - 头像组件,支持多种图片源和样式
|
||||
- **KTag** - 标签组件,用于内容分类和标记
|
||||
- **KImage** - 图片组件,支持懒加载和错误处理
|
||||
|
||||
#### 布局组件
|
||||
- **Container** - 布局容器,提供基础的页面布局结构
|
||||
- **Grid** - 栅格系统,支持响应式布局和灵活的列配置
|
||||
- **Space** - 间距组件,提供统一的元素间距管理
|
||||
- **KContainer** - 布局容器,提供基础的页面布局结构
|
||||
- **KGrid** - 栅格系统,支持响应式布局和灵活的列配置
|
||||
- **KSpace** - 间距组件,提供统一的元素间距管理
|
||||
|
||||
#### 反馈组件
|
||||
- **ChatBubble** - 聊天气泡组件,适用于对话界面
|
||||
- **Message** - 全局提示组件,提供操作反馈
|
||||
- **Notification** - 通知提醒组件,用于系统通知
|
||||
- **Loading** - 加载中组件,提供加载状态指示
|
||||
- **Result** - 结果页组件,用于操作结果展示
|
||||
- **Empty** - 空状态组件,用于空数据展示
|
||||
- **KChatBubble** - 聊天气泡组件,适用于对话界面
|
||||
- **KMessage** - 全局提示组件,提供操作反馈
|
||||
- **KNotification** - 通知提醒组件,用于系统通知
|
||||
- **KLoading** - 加载中组件,提供加载状态指示
|
||||
- **KResult** - 结果页组件,用于操作结果展示
|
||||
- **KEmpty** - 空状态组件,用于空数据展示
|
||||
|
||||
#### 核心功能
|
||||
- **主题系统**:支持明亮/暗黑主题切换和自定义主题
|
||||
@@ -98,5 +98,5 @@ knowai-ui/
|
||||
- 加入"vite-plugin-css-injected-by-js"插件,解决库模式下CSS文件独立打包无法注入的问题
|
||||
- 在vite入口引入所有scss文件,打包入es.js编译结果入口
|
||||
- JS仍保持tree-shaking优化,但css文件不再独立打包,而是与JS文件合并
|
||||
|
||||
- 更规范的全局样式文件命名
|
||||
|
||||
|
||||
Reference in New Issue
Block a user