From 9d497e0f8e902c80787baba792932279a72b23f2 Mon Sep 17 00:00:00 2001 From: haohao_peng Date: Mon, 17 Jun 2024 15:44:15 +0800 Subject: [PATCH] =?UTF-8?q?fix:=20[cli]=20=E5=B7=A6=E4=BE=A7=E8=8F=9C?= =?UTF-8?q?=E5=8D=95=E5=AF=BC=E8=88=AA=E6=9B=B4=E6=96=B0=20=E6=95=B0?= =?UTF-8?q?=E6=8D=AE=E5=B1=95=E7=A4=BA=20=3D\>=20=E5=B1=95=E7=A4=BA?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- COMPONENT.md | 2 +- components/avatar/index.md | 2 +- components/badge/index.md | 2 +- components/card/index.md | 2 +- components/carousel/index.md | 2 +- components/collapse/index.md | 2 +- components/drawer/index.md | 2 +- components/image-cropper/index.md | 2 +- components/image/index.md | 2 +- components/split-panel/index.md | 2 +- components/table/index.md | 24 +++++++++--------------- components/tag/index.md | 2 +- components/timeline/index.md | 2 +- site/consts.ts | 2 +- 14 files changed, 22 insertions(+), 28 deletions(-) diff --git a/COMPONENT.md b/COMPONENT.md index 3c8a68b0..08efd0b2 100644 --- a/COMPONENT.md +++ b/COMPONENT.md @@ -176,7 +176,7 @@ KDesign 组件库采用的测试框架是 `jest-enzyme`, [文档地址](https:// ### 4. 组件demo说明 模板的 `index.md` 是组件的文档说明。下面是对文档字段的一些说明 - type: 组件的归类 - - 目前组件分为基础、布局、导航、表单、数据展示、反馈、筛选7个类别。模板默认归类到 `基础`,大家根据要求进行调整。 + - 目前组件分为基础、布局、导航、表单、展示、反馈、筛选7个类别。模板默认归类到 `基础`,大家根据要求进行调整。 - order: 组件在归类列表中的排列顺序 - 目前此字段已经废弃，排列顺序会自动按照组件英文名首字母进行排序 - title: 组件的英文名 diff --git a/components/avatar/index.md b/components/avatar/index.md index 9c590548..1ae82c2b 100644 --- a/components/avatar/index.md +++ b/components/avatar/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 subtitle: 头像 title: Avatar order: 0 diff --git a/components/badge/index.md b/components/badge/index.md index cb10b301..83407f15 100644 --- a/components/badge/index.md +++ b/components/badge/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 title: Badge subtitle: 徽标数 order: 1 diff --git a/components/card/index.md b/components/card/index.md index c7f50eb1..07be95cb 100644 --- a/components/card/index.md +++ b/components/card/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 2 title: Card subtitle: 卡片 diff --git a/components/carousel/index.md b/components/carousel/index.md index 45e021cb..b5d8192d 100644 --- a/components/carousel/index.md +++ b/components/carousel/index.md @@ -1,7 +1,7 @@ --- category: Components order: 4 -type: 数据展示 +type: 展示 title: Carousel subtitle: 走马灯 --- diff --git a/components/collapse/index.md b/components/collapse/index.md index 8e0dbb06..6ead4519 100644 --- a/components/collapse/index.md +++ b/components/collapse/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 3 title: Collapse subtitle: 折叠面板 diff --git a/components/drawer/index.md b/components/drawer/index.md index 35d839a7..dcc8fcdd 100644 --- a/components/drawer/index.md +++ b/components/drawer/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 5 title: Drawer subtitle: 抽屉 diff --git a/components/image-cropper/index.md b/components/image-cropper/index.md index 42515703..1c9b60cf 100644 --- a/components/image-cropper/index.md +++ b/components/image-cropper/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 1 title: ImageCropper subtitle: 图片裁剪 diff --git a/components/image/index.md b/components/image/index.md index 463ba3aa..e18b5b97 100644 --- a/components/image/index.md +++ b/components/image/index.md @@ -2,7 +2,7 @@ category: Components subtitle: 图片 order: 6 -type: 数据展示 +type: 展示 title: Image --- diff --git a/components/split-panel/index.md b/components/split-panel/index.md index 379fc637..872e2339 100644 --- a/components/split-panel/index.md +++ b/components/split-panel/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 8 title: SplitPanel subtitle: 分割容器 diff --git a/components/table/index.md b/components/table/index.md index ecc1dbe4..09821bc3 100644 --- a/components/table/index.md +++ b/components/table/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 11 title: Table subtitle: 表格 @@ -288,14 +288,14 @@ interface columnSize { [key: string]: number } interface ChangedColumnSize { cod 属性`rangeSelection`为`{}`或设置`TableRangeSelection`时表体内部可范围选中表格 ```ts -interface TableRangeSelection { /** 范围选中回调函数 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ rangeSelectedChange?(params: any): void; /** 是否阻止 keydown 的默认行为 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ preventkDefaultOfKeyDownEvent?: boolean; } +interface TableRangeSelection { /** 范围选中回调函数 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ rangeSelectedChange?(params: any): void; /** 是否阻止 keydown 的默认行为 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ preventkDefaultOfKeyDownEvent?: boolean; } ``` ### 组件替换 属性`components`可替换表格内部的一些子组件，如：加载动画图标、数据为空的展现效果。 ```ts -interface Components { /** 表格加载时的加载图标 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ LoadingIcon?: React.ComponentType; /** 数据为空时，表格的展示内容。 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ EmptyContent?: React.ComponentType; } +interface Components { /** 表格加载时的加载图标 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ LoadingIcon?: React.ComponentType; /** 数据为空时，表格的展示内容。 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \*/ EmptyContent?: React.ComponentType; } ``` ### rowDrag @@ -303,23 +303,17 @@ interface Components { /** 表格加载时的加载图标 \ \ \ \ \ \ \ \ \ \ \ ```ts interface TableRowDrag { - /** 拖拽开始事件 */ - onDragStart?:(event:RowDragEvent) => void, +/\*_ 拖拽开始事件 _/ onDragStart?:(event:RowDragEvent) => void, - /** 拖拽移动事件 */ - onDragMove?:(event:RowDragEvent) => void, +/\*_ 拖拽移动事件 _/ onDragMove?:(event:RowDragEvent) => void, - /** 拖拽结束事件 */ - onDragEnd?:(event:RowDragEvent) => void, +/\*_ 拖拽结束事件 _/ onDragEnd?:(event:RowDragEvent) => void, - /** 判断一行是否要禁用拖拽 */ - isDisabled?:(row: any, rowIndex: number) => boolean, +/\*_ 判断一行是否要禁用拖拽 _/ isDisabled?:(row: any, rowIndex: number) => boolean, - /** 拖拽列定义 */ - rowDragColumn?: ArtColumn, +/\*_ 拖拽列定义 _/ rowDragColumn?: ArtColumn, - /** 行高 */ - rowHeight?: number +/\*_ 行高 _/ rowHeight?: number } ``` diff --git a/components/tag/index.md b/components/tag/index.md index 28c4ea80..7b228954 100644 --- a/components/tag/index.md +++ b/components/tag/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 4 title: Tag subtitle: 标签 diff --git a/components/timeline/index.md b/components/timeline/index.md index ed444d5a..80faffc1 100644 --- a/components/timeline/index.md +++ b/components/timeline/index.md @@ -1,6 +1,6 @@ --- category: Components -type: 数据展示 +type: 展示 order: 9 title: Timeline subtitle: 时间轴 diff --git a/site/consts.ts b/site/consts.ts index 9091c755..cf7cb01c 100644 --- a/site/consts.ts +++ b/site/consts.ts @@ -18,7 +18,7 @@ export const typeOrder: Record = { 布局: 1, 导航: 2, 表单: 3, - 数据展示: 4, + 展示: 4, 反馈: 5, 筛选: 6, }