From 22621f1fa908aaca54027e0928446e472b12acd0 Mon Sep 17 00:00:00 2001 From: "LINING-PC\\lining" Date: Mon, 12 Jan 2026 10:53:12 +0800 Subject: [PATCH] v1.7.1 - README updates --- README-EN.md | 64 ++++++++++++++++++++-------------------------------- README.md | 64 ++++++++++++++++++++-------------------------------- 2 files changed, 48 insertions(+), 80 deletions(-) diff --git a/README-EN.md b/README-EN.md index edfd692..8f7fc43 100644 --- a/README-EN.md +++ b/README-EN.md @@ -1,21 +1,5 @@ # jordium-gantt-vue3 logo jordium-gantt-vue3 - -

npm version @@ -216,11 +200,11 @@ npm run dev | `enableTaskListContextMenu` | `boolean` | `true` | Whether to enable TaskList (TaskRow) context menu. When `true`: uses built-in menu if `task-list-context-menu` slot is not declared, uses custom menu if slot is declared; when `false`: context menu is completely disabled | | `enableTaskBarContextMenu` | `boolean` | `true` | Whether to enable TaskBar context menu. When `true`: uses built-in menu if `task-bar-context-menu` slot is not declared, uses custom menu if slot is declared; when `false`: context menu is completely disabled | | `assigneeOptions` | `Array<{ key?: string \| number; value: string \| number; label: string }>` | `[]` | Assignee dropdown options in task edit drawer | -| `locale` 1.7.1 | `'zh-CN' \| 'en-US'` | `'zh-CN'` | Language setting (reactive). Component's internal language will follow changes | -| `theme` 1.7.1 | `'light' \| 'dark'` | `'light'` | Theme mode (reactive). Component's theme will follow changes | -| `timeScale` 1.7.1 | `'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'` | `'week'` | Time scale (reactive). Timeline scale will follow changes | -| `fullscreen` 1.7.1 | `boolean` | `false` | Fullscreen state control (reactive). Component's fullscreen state will follow changes | -| `expandAll` 1.7.1 | `boolean` | `true` | Expand/collapse all tasks (reactive). All tasks' expand state will follow changes | +| `locale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `'zh-CN' \| 'en-US'` | `'zh-CN'` | Language setting (reactive). Component's internal language will follow changes | +| `theme` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `'light' \| 'dark'` | `'light'` | Theme mode (reactive). Component's theme will follow changes | +| `timeScale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'` | `'week'` | Time scale (reactive). Timeline scale will follow changes | +| `fullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `boolean` | `false` | Fullscreen state control (reactive). Component's fullscreen state will follow changes | +| `expandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `boolean` | `true` | Expand/collapse all tasks (reactive). All tasks' expand state will follow changes | #### TaskListColumn Component Props @@ -2125,25 +2109,25 @@ The GanttChart component exposes a series of methods through `defineExpose`, all | Method | Parameters | Return Value | Description | | --- | --- | --- | --- | -| `setLocale` 1.7.1 | `locale: 'zh-CN' \| 'en-US'` | `void` | Set component language | -| `currentLocale` 1.7.1 | - | `'zh-CN' \| 'en-US'` | Get current language setting | -| `setTheme` 1.7.1 | `mode: 'light' \| 'dark'` | `void` | Set theme mode | -| `currentTheme` 1.7.1 | - | `'light' \| 'dark'` | Get current theme mode | -| `setTimeScale` 1.7.1 | `scale: TimelineScale` | `void` | Set time scale (`'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'`) | -| `zoomIn` 1.7.1 | - | `void` | zoom in time scale（`'year' -> 'quarter' -> 'month' -> 'week' -> 'day' -> 'hour'`） | -| `zoomOut` 1.7.1 | - | `void` | zoom out time scale（`'hour' -> 'day' -> 'week' -> 'month' -> 'quarter' -> 'year'`） | -| `currentScale` 1.7.1 | - | `TimelineScale` | Get current time scale | -| `toggleFullscreen` 1.7.1 | - | `void` | Toggle fullscreen state | -| `enterFullscreen` 1.7.1 | - | `void` | Enter fullscreen mode | -| `exitFullscreen` 1.7.1 | - | `void` | Exit fullscreen mode | -| `isFullscreen` 1.7.1 | - | `boolean` | Get current fullscreen state | -| `toggleExpandAll` 1.7.1 | - | `void` | Toggle expand/collapse all tasks | -| `expandAll` 1.7.1 | - | `void` | Expand all tasks | -| `collapseAll` 1.7.1 | - | `void` | Collapse all tasks | -| `isExpandAll` 1.7.1 | - | `boolean` | Get current expand all state | -| `scrollToToday` 1.7.1 | - | `void` | Scroll to today's position | -| `scrollToTask` 1.7.1 | `taskId: number \| string` | `void` | Scroll to specified task (task will auto-expand to visible state) | -| `scrollToDate` 1.7.1 | `date: string \| Date` | `void` | Scroll to specified date position (format: `'YYYY-MM-DD'` or Date object) | +| `setLocale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `locale: 'zh-CN' \| 'en-US'` | `void` | Set component language | +| `currentLocale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `'zh-CN' \| 'en-US'` | Get current language setting | +| `setTheme` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `mode: 'light' \| 'dark'` | `void` | Set theme mode | +| `currentTheme` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `'light' \| 'dark'` | Get current theme mode | +| `setTimeScale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `scale: TimelineScale` | `void` | Set time scale (`'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'`) | +| `zoomIn` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | zoom in time scale（`'year' -> 'quarter' -> 'month' -> 'week' -> 'day' -> 'hour'`） | +| `zoomOut` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | zoom out time scale（`'hour' -> 'day' -> 'week' -> 'month' -> 'quarter' -> 'year'`） | +| `currentScale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `TimelineScale` | Get current time scale | +| `toggleFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | Toggle fullscreen state | +| `enterFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | Enter fullscreen mode | +| `exitFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | Exit fullscreen mode | +| `isFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `boolean` | Get current fullscreen state | +| `toggleExpandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | Toggle expand/collapse all tasks | +| `expandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | Expand all tasks | +| `collapseAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | Collapse all tasks | +| `isExpandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `boolean` | Get current expand all state | +| `scrollToToday` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | Scroll to today's position | +| `scrollToTask` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `taskId: number \| string` | `void` | Scroll to specified task (task will auto-expand to visible state) | +| `scrollToDate` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `date: string \| Date` | `void` | Scroll to specified date position (format: `'YYYY-MM-DD'` or Date object) | #### Usage Example diff --git a/README.md b/README.md index 23ac34f..df5cdca 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,5 @@ # jordium-gantt-vue3 logo jordium-gantt-vue3 - -

npm version @@ -214,11 +198,11 @@ npm run dev | `enableTaskListContextMenu` | `boolean` | `true` | 是否启用 TaskList（TaskRow）右键菜单功能。为 `true` 时：未声明 `task-list-context-menu` 插槽则使用内置菜单，声明了插槽则使用自定义菜单；为 `false` 时右键菜单完全禁用 | | `enableTaskBarContextMenu` | `boolean` | `true` | 是否启用 TaskBar 右键菜单功能。为 `true` 时：未声明 `task-bar-context-menu` 插槽则使用内置菜单，声明了插槽则使用自定义菜单；为 `false` 时右键菜单完全禁用 | | `assigneeOptions` | `Array<{ key?: string \| number; value: string \| number; label: string }>` | `[]` | 任务编辑抽屉中负责人下拉菜单的选项列表 | -| `locale` 1.7.1 | `'zh-CN' \| 'en-US'` | `'zh-CN'` | 语言设置（响应式）。设置后组件内部语言将跟随变化 | -| `theme` 1.7.1 | `'light' \| 'dark'` | `'light'` | 主题模式（响应式）。设置后组件主题将跟随变化 | -| `timeScale` 1.7.1 | `'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'` | `'week'` | 时间刻度（响应式）。设置后时间线刻度将跟随变化 | -| `fullscreen` 1.7.1 | `boolean` | `false` | 全屏状态控制（响应式）。设置后组件全屏状态将跟随变化 | -| `expandAll` 1.7.1 | `boolean` | `true` | 展开/收起所有任务（响应式）。设置后所有任务的展开状态将跟随变化 | +| `locale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `'zh-CN' \| 'en-US'` | `'zh-CN'` | 语言设置（响应式）。设置后组件内部语言将跟随变化 | +| `theme` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `'light' \| 'dark'` | `'light'` | 主题模式（响应式）。设置后组件主题将跟随变化 | +| `timeScale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'` | `'week'` | 时间刻度（响应式）。设置后时间线刻度将跟随变化 | +| `fullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `boolean` | `false` | 全屏状态控制（响应式）。设置后组件全屏状态将跟随变化 | +| `expandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `boolean` | `true` | 展开/收起所有任务（响应式）。设置后所有任务的展开状态将跟随变化 | #### TaskListColumn 属性 @@ -2116,25 +2100,25 @@ GanttChart 组件通过 `defineExpose` 暴露了一系列方法，允许父组 | 方法名 | 参数 | 返回值 | 说明 | | --- | --- | --- | --- | -| `setLocale` 1.7.1 | `locale: 'zh-CN' \| 'en-US'` | `void` | 设置组件语言 | -| `currentLocale` 1.7.1 | - | `'zh-CN' \| 'en-US'` | 获取当前语言设置 | -| `setTheme` 1.7.1 | `mode: 'light' \| 'dark'` | `void` | 设置主题模式 | -| `currentTheme` 1.7.1 | - | `'light' \| 'dark'` | 获取当前主题模式 | -| `setTimeScale` 1.7.1 | `scale: TimelineScale` | `void` | 设置时间刻度（`'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'`） | -| `zoomIn` 1.7.1 | - | `void` | 缩小时间刻度（`'year' -> 'quarter' -> 'month' -> 'week' -> 'day' -> 'hour'`） | -| `zoomOut` 1.7.1 | - | `void` | 放大时间刻度（`'hour' -> 'day' -> 'week' -> 'month' -> 'quarter' -> 'year'`） | -| `currentScale` 1.7.1 | - | `TimelineScale` | 获取当前时间刻度 | -| `toggleFullscreen` 1.7.1 | - | `void` | 切换全屏状态 | -| `enterFullscreen` 1.7.1 | - | `void` | 进入全屏模式 | -| `exitFullscreen` 1.7.1 | - | `void` | 退出全屏模式 | -| `isFullscreen` 1.7.1 | - | `boolean` | 获取当前是否处于全屏状态 | -| `toggleExpandAll` 1.7.1 | - | `void` | 切换展开/收起所有任务 | -| `expandAll` 1.7.1 | - | `void` | 展开所有任务 | -| `collapseAll` 1.7.1 | - | `void` | 收起所有任务 | -| `isExpandAll` 1.7.1 | - | `boolean` | 获取当前是否全部展开 | -| `scrollToToday` 1.7.1 | - | `void` | 滚动到今天的位置 | -| `scrollToTask` 1.7.1 | `taskId: number \| string` | `void` | 滚动到指定任务（任务会自动展开到可见状态） | -| `scrollToDate` 1.7.1 | `date: string \| Date` | `void` | 滚动到指定日期位置（格式：`'YYYY-MM-DD'` 或 Date 对象） | +| `setLocale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `locale: 'zh-CN' \| 'en-US'` | `void` | 设置组件语言 | +| `currentLocale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `'zh-CN' \| 'en-US'` | 获取当前语言设置 | +| `setTheme` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `mode: 'light' \| 'dark'` | `void` | 设置主题模式 | +| `currentTheme` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `'light' \| 'dark'` | 获取当前主题模式 | +| `setTimeScale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `scale: TimelineScale` | `void` | 设置时间刻度（`'hour' \| 'day' \| 'week' \| 'month' \| 'quarter' \| 'year'`） | +| `zoomIn` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 缩小时间刻度（`'year' -> 'quarter' -> 'month' -> 'week' -> 'day' -> 'hour'`） | +| `zoomOut` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 放大时间刻度（`'hour' -> 'day' -> 'week' -> 'month' -> 'quarter' -> 'year'`） | +| `currentScale` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `TimelineScale` | 获取当前时间刻度 | +| `toggleFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 切换全屏状态 | +| `enterFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 进入全屏模式 | +| `exitFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 退出全屏模式 | +| `isFullscreen` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `boolean` | 获取当前是否处于全屏状态 | +| `toggleExpandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 切换展开/收起所有任务 | +| `expandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 展开所有任务 | +| `collapseAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 收起所有任务 | +| `isExpandAll` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `boolean` | 获取当前是否全部展开 | +| `scrollToToday` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | - | `void` | 滚动到今天的位置 | +| `scrollToTask` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `taskId: number \| string` | `void` | 滚动到指定任务（任务会自动展开到可见状态） | +| `scrollToDate` ![v1.7.1](https://img.shields.io/badge/v1.7.1-409EFF?style=flat-square&labelColor=ECF5FF) | `date: string \| Date` | `void` | 滚动到指定日期位置（格式：`'YYYY-MM-DD'` 或 Date 对象） | #### 使用示例