From 1c054a5eab473a6b07efc22dc099b16c23064ee5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E5=87=AF=E5=8D=9A?= <45080430@gitlab.com> Date: Tue, 19 Aug 2025 10:23:42 +0800 Subject: [PATCH] =?UTF-8?q?feat:=E5=AE=8C=E5=96=84=E5=BF=AB=E9=80=9F?= =?UTF-8?q?=E5=BC=80=E5=A7=8B=E5=8A=9F=E8=83=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- frontend/src/views/dashboard/README.md | 374 ++++++++++++++++++++----- 1 file changed, 303 insertions(+), 71 deletions(-) diff --git a/frontend/src/views/dashboard/README.md b/frontend/src/views/dashboard/README.md index 288e39d9..4d16d6b6 100644 --- a/frontend/src/views/dashboard/README.md +++ b/frontend/src/views/dashboard/README.md @@ -1,118 +1,186 @@ -# 快速开始组件功能说明 +# Dashboard 仪表板模块 ## 概述 -快速开始组件提供了一个便捷的导航面板,用户可以快速访问常用的页面和外部链接。支持从标签栏右键收藏页面到快速开始列表。 +Dashboard 仪表板模块是系统的核心展示区域,提供了数据概览、快速导航、工作台等功能。包含工作台页面、数据分析页面以及可复用的组件库。 -## 功能特性 +## 模块结构 -### 1. 快速链接管理 -- ✅ 显示预设的常用链接 +``` +dashboard/ +├── workplace.vue # 工作台主页面 +├── analysis.vue # 数据分析页面 +├── components/ # 可复用组件 +│ ├── QuickStart.vue # 快速开始组件 +│ ├── AddQuickLinkDialog.vue # 添加快速链接对话框 +│ └── index.ts # 组件导出文件 +└── README.md # 模块说明文档 +``` + +## 页面功能 + +### 1. 工作台页面 (workplace.vue) + +**核心功能:** +- ✅ 用户欢迎信息展示 +- ✅ 进行中的项目列表 +- ✅ 动态时间线 +- ✅ 快速开始/便捷导航 +- ✅ 数据指数图表 +- ✅ 团队成员展示 + +**布局特点:** +- 响应式栅格布局 +- 左右分栏设计 +- 卡片式组件展示 +- 移动端适配 + +### 2. 数据分析页面 (analysis.vue) + +**主要功能:** +- ✅ 数据统计图表 +- ✅ 趋势分析展示 +- ✅ 实时数据监控 +- ✅ 可视化数据报表 + +## 组件功能 + +### 1. 快速开始组件 (QuickStart.vue) + +#### 核心特性 +- ✅ 快速链接管理和展示 - ✅ 支持内部路由跳转和外部链接访问 - ✅ 固定高度容器,内容可滚动 - ✅ 响应式设计,适配不同屏幕尺寸 -### 2. 标签栏右键收藏 +#### 标签栏右键收藏 - ✅ 在任意标签页右击可收藏到快速开始 - ✅ 支持切换收藏状态(收藏/取消收藏) - ✅ 自动获取路由配置的图标 - ✅ 智能图标匹配和颜色配置 - ✅ 实时状态显示和图标切换 -### 3. 手动添加链接 +#### 手动添加链接 - ✅ 通过对话框手动添加自定义链接 - ✅ 支持选择图标和自定义颜色 - ✅ 表单验证确保数据正确性 - ✅ 支持内部链接和外部链接 -### 4. 右键管理链接 +#### 右键管理链接 - ✅ 在快速链接上右击可编辑或删除 -- ✅ 编辑功能支持修改所有属性 +- ✅ 编辑功能自动预填充现有数据 - ✅ 删除功能带有确认对话框 - ✅ 防止误操作的安全提示 -### 4. 数据持久化 +#### 数据持久化 - ✅ 使用 localStorage 保存用户配置 - ✅ 页面刷新后数据不丢失 -- ✅ 支持导入/导出配置(后续可扩展) +- ✅ 支持导入/导出配置(可扩展) -## 使用方法 +### 2. 添加快速链接对话框 (AddQuickLinkDialog.vue) -### 从标签栏收藏页面 +#### 功能特性 +- ✅ 支持新增和编辑两种模式 +- ✅ 完整的表单验证 +- ✅ 图标选择器(22个常用图标) +- ✅ 颜色自定义选择 +- ✅ 链接类型区分(内部/外部) -#### 收藏页面 +## 使用指南 + +### 访问 Dashboard + +#### 工作台页面 +- **路径**:`/dashboard/workplace` +- **功能**:个人工作台,包含项目概览、动态信息、快速导航等 +- **适用场景**:日常工作的起始页面 + +#### 数据分析页面 +- **路径**:`/dashboard/analysis` +- **功能**:数据统计和分析展示 +- **适用场景**:查看系统数据和业务指标 + +### 快速开始组件使用 + +#### 从标签栏收藏页面 + +**收藏页面:** 1. 在任意页面的标签上右击 2. 选择"收藏到快速开始" 3. 系统会自动获取路由图标和颜色 4. 前往工作台查看新添加的链接 -#### 取消收藏 +**取消收藏:** 1. 在已收藏页面的标签上右击 2. 选择"取消收藏"(图标会显示为实心星星) 3. 链接立即从快速开始列表中移除 -#### 自动图标获取 +**自动图标获取:** - **优先级1**:使用路由 `meta.icon` 配置 - **优先级2**:根据路径智能匹配预设图标 - **优先级3**:使用默认链接图标 -### 手动添加链接 +#### 手动添加链接 1. 在快速开始组件中点击"添加"按钮 2. 填写链接信息: - - 标题:链接显示名称 - - 描述:链接说明文字 - - 链接地址:内部路径或外部URL - - 链接类型:内部链接或外部链接 - - 图标:从预设图标中选择 - - 颜色:自定义图标颜色 + - **标题**:链接显示名称 + - **描述**:链接说明文字 + - **链接地址**:内部路径或外部URL + - **链接类型**:内部链接或外部链接 + - **图标**:从预设图标中选择 + - **颜色**:自定义图标颜色 3. 点击确定保存 -### 管理快速链接 +#### 管理快速链接 -#### 右键菜单操作 +**编辑链接:** +1. 在快速开始组件中右击任意链接 +2. 选择"编辑链接" +3. 对话框会自动填充现有的链接信息 +4. 修改需要更改的字段 +5. 点击"确定"保存修改 -1. **编辑链接**: - - 在快速开始组件中右击任意链接 - - 选择"编辑链接" - - 对话框会自动填充现有的链接信息 - - 修改需要更改的字段 - - 点击"确定"保存修改 +**删除链接:** +1. 在快速开始组件中右击任意链接 +2. 选择"删除链接" +3. 在确认对话框中点击"确定" -2. **删除链接**: - - 在快速开始组件中右击任意链接 - - 选择"删除链接" - - 在确认对话框中点击"确定" - -### 使用快速链接 +#### 使用快速链接 - **内部链接**:点击后在当前窗口跳转 - **外部链接**:点击后在新标签页打开,带有"外链"标识 -## 技术实现 +## 技术架构 -### 组件结构 +### 目录结构 -``` -dashboard/components/ -├── QuickStart.vue # 主要的快速开始组件 -├── AddQuickLinkDialog.vue # 添加快速链接对话框 -├── index.ts # 组件导出文件 -└── README.md # 功能说明文档 +```text +dashboard/ +├── workplace.vue # 工作台主页面 +├── analysis.vue # 数据分析页面 +├── components/ # 组件库 +│ ├── QuickStart.vue # 快速开始组件 +│ ├── AddQuickLinkDialog.vue # 添加链接对话框 +│ └── index.ts # 组件导出 +└── README.md # 模块文档 ``` -### 核心文件 +### 核心技术栈 -- `QuickStart.vue`: 主组件,负责显示快速链接列表 -- `AddQuickLinkDialog.vue`: 添加/编辑对话框 -- `utils/quickStartManager.ts`: 全局数据管理器 -- `layouts/components/TagsView/index.vue`: 标签栏组件(已修改) +- **Vue 3**: Composition API + `