fix(Descriptions): fix helper (#5182)

liweijie0812 · uyarn · web-flow · commit ae5ec91c9e70 · 2025-03-15T11:40:47.000+08:00
* fix(Descriptions): fix helper

* chore: fix lint

* chore: fix lint

* chore: fix lint

* chore: remove color-picker event

* Remove 'align' and 'clear' attributes.

---------

Co-authored-by: wū yāng &lt;uyarnchen@gmail.com&gt;
diff --git a/packages/components/descriptions/descriptions-item-props.ts b/packages/components/descriptions/descriptions-item-props.ts
@@ -4,21 +4,21 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
-import { TdDescriptionItemProps } from '../descriptions/type';
+import { TdDescriptionsItemProps } from '../descriptions/type';
 import { PropType } from 'vue';
 
 export default {
   /** 描述项内容 */
   content: {
-    type: [String, Function] as PropType<TdDescriptionItemProps['content']>,
+    type: [String, Function] as PropType<TdDescriptionsItemProps['content']>,
   },
   /** 描述项内容，同 `content` */
   default: {
-    type: [String, Function] as PropType<TdDescriptionItemProps['default']>,
+    type: [String, Function] as PropType<TdDescriptionsItemProps['default']>,
   },
   /** 描述项标签 */
   label: {
-    type: [String, Function] as PropType<TdDescriptionItemProps['label']>,
+    type: [String, Function] as PropType<TdDescriptionsItemProps['label']>,
   },
   /** 占用的宽度数量 */
   span: {
diff --git a/packages/components/descriptions/descriptions-item.tsx b/packages/components/descriptions/descriptions-item.tsx
@@ -1,5 +1,5 @@
 import { defineComponent } from 'vue';
-import props from './description-item-props';
+import props from './descriptions-item-props';
 
 export default defineComponent({
   name: 'TDescriptionsItem',
diff --git a/packages/components/descriptions/descriptions-row.tsx b/packages/components/descriptions/descriptions-row.tsx
@@ -1,13 +1,13 @@
 import { computed, defineComponent, inject, PropType } from 'vue';
 import { useConfig, usePrefixClass } from '../hooks/useConfig';
 import { descriptionsKey } from './consts';
-import { ItemsType, TdDescriptionItem } from './types';
+import { ItemsType, TdDescriptionsItem } from './types';
 import { renderVNodeTNode, itemTypeIsProps } from './utils';
 
 export default defineComponent({
   name: 'TDescriptionsRow',
   props: {
-    row: Array as PropType<TdDescriptionItem[]>,
+    row: Array as PropType<TdDescriptionsItem[]>,
     itemType: String as PropType<ItemsType>,
   },
   setup(props) {
@@ -17,7 +17,7 @@ export default defineComponent({
     const layoutIsHorizontal = computed(() => descriptionsProps.layout === 'horizontal');
     const itemLayoutIsHorizontal = computed(() => descriptionsProps.itemLayout === 'horizontal');
 
-    const label = (node: TdDescriptionItem) => {
+    const label = (node: TdDescriptionsItem) => {
       const labelClass = [`${COMPONENT_NAME.value}__label`];
 
       let label = null;
@@ -39,7 +39,7 @@ export default defineComponent({
       );
     };
 
-    const content = (node: TdDescriptionItem) => {
+    const content = (node: TdDescriptionsItem) => {
       const contentClass = [`${COMPONENT_NAME.value}__content`];
 
       let content = null;
diff --git a/packages/components/descriptions/descriptions.en-US.md b/packages/components/descriptions/descriptions.en-US.md
@@ -8,17 +8,18 @@ name | type | default | description | required
 -- | -- | -- | -- | --
 bordered | Boolean | false | set description list with grey border | N
 colon | Boolean | - | set label with ":" on the right | N
-column | Number | 2 | count of DescriptionItem in one row | N
+column | Number | 2 | count of DescriptionsItem in one row | N
 contentStyle | Object | - | style of description content。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 itemLayout | String | horizontal | layout direction of description item。options: horizontal/vertical | N
-items | Array | - | list of descriptions items。Typescript：`Array<TdDescriptionItemProps>` | N
+items | Array | - | list of descriptions items。Typescript：`Array<TdDescriptionsItemProps>` | N
 labelStyle | Object | - | style of description item, which takes effect when `tableLayout` is `auto`。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 layout | String | horizontal | layout direction。options: horizontal/vertical | N
 size | String | medium | a descriptions has three size。options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 tableLayout | String | fixed | Sets the algorithm used to layout `table` cells, rows, and columns, exactly the same as the native table-layout css property. `fixed`: uses fixed layout algorithm; `auto`: uses automatic layout algorithm. For more details, see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。options: fixed/auto | N
 title | String / Slot / Function | - | title of descriptions。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 
-### DescriptionItem Props
+
+### DescriptionsItem Props
 
 name | type | default | description | required
 -- | -- | -- | -- | --
diff --git a/packages/components/descriptions/descriptions.md b/packages/components/descriptions/descriptions.md
@@ -8,17 +8,18 @@
 -- | -- | -- | -- | --
 bordered | Boolean | false | 是否带边框 | N
 colon | Boolean | - | 字段名右侧是否携带冒号“：” | N
-column | Number | 2 | 一行 `DescriptionItem` 的数量 | N
+column | Number | 2 | 一行 `DescriptionsItem` 的数量 | N
 contentStyle | Object | - | 自定义描述项内容的样式。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 itemLayout | String | horizontal | 描述项的排列方向。可选项：horizontal/vertical | N
-items | Array | - | 描述项的列表。TS 类型：`Array<TdDescriptionItemProps>` | N
+items | Array | - | 描述项的列表。TS 类型：`Array<TdDescriptionsItemProps>` | N
 labelStyle | Object | - | 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效。TS 类型：`Styles`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 layout | String | horizontal | 排列方向。可选项：horizontal/vertical | N
 size | String | medium | 组件尺寸。可选项：small/medium/large。TS 类型：`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 tableLayout | String | fixed | 用于设置底层 `table` 单元格、行和列的布局算法，与原生 table-layout css 属性完全一致。`fixed`：采用固定布局算法；`auto`：采用自动布局算法。详情可参考 [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。可选项：fixed/auto | N
 title | String / Slot / Function | - | 描述列表的标题。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/packages/components/common.ts) | N
 
-### DescriptionItem Props
+
+### DescriptionsItem Props
 
 名称 | 类型 | 默认值 | 描述 | 必传
 -- | -- | -- | -- | --
diff --git a/packages/components/descriptions/descriptions.tsx b/packages/components/descriptions/descriptions.tsx
@@ -11,7 +11,7 @@ import { descriptionsKey } from './consts';
 import { TdDescriptionsProps } from './type';
 import DescriptionsRow from './descriptions-row';
 import { renderCustomNode, itemTypeIsProps } from './utils';
-import { ItemsType, TdDescriptionItem } from './types';
+import { ItemsType, TdDescriptionsItem } from './types';
 
 /**
  * 实现思路
@@ -47,7 +47,7 @@ export default defineComponent({
        */
       const { column, layout } = props;
 
-      let items: TdDescriptionItem[] = [];
+      let items: TdDescriptionsItem[] = [];
 
       if (isArray(props.items)) {
         /**
@@ -76,11 +76,11 @@ export default defineComponent({
       }
 
       // 3. 布局为 HORIZONTAL 时，需要计算每一行的 item 个数
-      let temp: TdDescriptionItem[] = [];
+      let temp: TdDescriptionsItem[] = [];
       let reset = column;
 
       // 4. 记录结果
-      const res: TdDescriptionItem[][] = [];
+      const res: TdDescriptionsItem[][] = [];
       items.forEach((item, index) => {
         let span = 1;
         if (itemTypeIsProps(itemsType.value, item)) {
diff --git a/packages/components/descriptions/index.ts b/packages/components/descriptions/index.ts
@@ -1,13 +1,13 @@
 import _Descriptions from './descriptions';
 import _DescriptionsItem from './descriptions-item';
 import withInstall from '../utils/withInstall';
-import { TdDescriptionsProps, TdDescriptionItemProps } from './type';
+import { TdDescriptionsProps, TdDescriptionsItemProps } from './type';
 
 import './style';
 
 export * from './type';
 export type DescriptionsProps = TdDescriptionsProps;
-export type DescriptionsItemProps = TdDescriptionItemProps;
+export type DescriptionsItemProps = TdDescriptionsItemProps;
 
 export const Descriptions = withInstall(_Descriptions);
 export const DescriptionsItem = withInstall(_DescriptionsItem);
diff --git a/packages/components/descriptions/props.ts b/packages/components/descriptions/props.ts
@@ -12,7 +12,7 @@ export default {
   bordered: Boolean,
   /** 字段名右侧是否携带冒号“：” */
   colon: Boolean,
-  /** 一行 `DescriptionItem` 的数量 */
+  /** 一行 `DescriptionsItem` 的数量 */
   column: {
     type: Number,
     default: 2,
@@ -34,7 +34,7 @@ export default {
   items: {
     type: Array as PropType<TdDescriptionsProps['items']>,
   },
-  /** 自定义描述项标签的样式 */
+  /** 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效 */
   labelStyle: {
     type: Object as PropType<TdDescriptionsProps['labelStyle']>,
   },
diff --git a/packages/components/descriptions/type.ts b/packages/components/descriptions/type.ts
@@ -17,7 +17,7 @@ export interface TdDescriptionsProps {
    */
   colon?: boolean;
   /**
-   * 一行 `DescriptionItem` 的数量
+   * 一行 `DescriptionsItem` 的数量
    * @default 2
    */
   column?: number;
@@ -33,9 +33,9 @@ export interface TdDescriptionsProps {
   /**
    * 描述项的列表
    */
-  items?: Array<TdDescriptionItemProps>;
+  items?: Array<TdDescriptionsItemProps>;
   /**
-   * 自定义描述项标签的样式
+   * 自定义描述项标签的样式，需要配合 `tableLayout` 为 `auto` 才可以生效
    */
   labelStyle?: Styles;
   /**
@@ -59,7 +59,7 @@ export interface TdDescriptionsProps {
   title?: string | TNode;
 }
 
-export interface TdDescriptionItemProps {
+export interface TdDescriptionsItemProps {
   /**
    * 描述项内容
    */
diff --git a/packages/components/descriptions/types.ts b/packages/components/descriptions/types.ts
@@ -1,9 +1,9 @@
 import type { VNode } from 'vue';
-import { TdDescriptionItemProps } from './type';
+import { TdDescriptionsItemProps } from './type';
 
 export enum ItemsType {
   props = 'props',
   slots = 'slots',
 }
 
-export type TdDescriptionItem = TdDescriptionItemProps | VNode;
+export type TdDescriptionsItem = TdDescriptionsItemProps | VNode;
diff --git a/packages/components/descriptions/utils/index.ts b/packages/components/descriptions/utils/index.ts
@@ -2,8 +2,8 @@ import { VNode, Slots, h, ComponentOptions } from 'vue';
 import { isFunction } from 'lodash-es';
 import { isString } from 'lodash-es';
 
-import { ItemsType, TdDescriptionItem } from '../types';
-import { TdDescriptionItemProps } from '../type';
+import { ItemsType, TdDescriptionsItem } from '../types';
+import { TdDescriptionsItemProps } from '../type';
 
 /**
  * ! 处理 node string / <div> / () => <div> / Component
@@ -53,6 +53,6 @@ export function renderVNodeTNode(node: VNode, name1: string, name2?: string) {
  * @param item
  * @returns
  */
-export function itemTypeIsProps(itemsType: ItemsType, item: TdDescriptionItem): item is TdDescriptionItemProps {
+export function itemTypeIsProps(itemsType: ItemsType, item: TdDescriptionsItem): item is TdDescriptionsItemProps {
   return itemsType === ItemsType.props;
 }
diff --git a/packages/tdesign-vue-next/global.d.ts b/packages/tdesign-vue-next/global.d.ts
@@ -38,8 +38,8 @@ declare module 'vue' {
     TDatePickerPanel: typeof import('tdesign-vue-next')['DatePickerPanel'];
     TDateRangePicker: typeof import('tdesign-vue-next')['DateRangePicker'];
     TDateRangePickerPanel: typeof import('tdesign-vue-next')['DateRangePickerPanel'];
-    TDescriptionItem: typeof import('tdesign-vue-next')['DescriptionItem'];
     TDescriptions: typeof import('tdesign-vue-next')['Descriptions'];
+    TDescriptionsItem: typeof import('tdesign-vue-next')['DescriptionsItem'];
     TDialog: typeof import('tdesign-vue-next')['Dialog'];
     TDialogCard: typeof import('tdesign-vue-next')['DialogCard'];
     TDivider: typeof import('tdesign-vue-next')['Divider'];
diff --git a/packages/tdesign-vue-next/helper/attributes.json b/packages/tdesign-vue-next/helper/attributes.json
@@ -2408,39 +2408,14 @@
     "type": "event",
     "description": "年份切换发生变化时触发\n\n[docs](https://tdesign.tencent.com/vue-next/components/date-picker?tab=api#daterangepickerpanel-events)"
   },
-  "t-description-item/align": {
-    "type": "String",
-    "options": [
-      "top",
-      "middle",
-      "bottom"
-    ],
-    "description": "content align type\n\n内容垂直对齐方式，DescriptionItem.align 优先级高于 Descriptions.align\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionitem-props)"
-  },
-  "t-description-item/content": {
-    "type": "String|TNode",
-    "description": "content of description item\n\n描述项内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionitem-props)"
-  },
-  "t-description-item/default": {
-    "type": "String|TNode",
-    "description": "content of description item\n\n描述项内容，同 `content`\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionitem-props)"
-  },
-  "t-description-item/label": {
-    "type": "String|TNode",
-    "description": "label of description item\n\n描述项标签\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionitem-props)"
-  },
-  "t-description-item/span": {
-    "type": "Number",
-    "description": "width count\n\n占用的宽度数量\n\ndefault: 1\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionitem-props)"
-  },
   "t-descriptions/align": {
     "type": "String",
     "options": [
       "top",
       "middle",
       "bottom"
     ],
-    "description": "content align type\n\n内容垂直对齐方式，DescriptionItem.align 优先级高于 Descriptions.align\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptions-props)"
+    "description": "content align type\n\n内容垂直对齐方式，DescriptionsItem.align 优先级高于 Descriptions.align\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptions-props)"
   },
   "t-descriptions/bordered": {
     "type": "Boolean",
@@ -2452,7 +2427,7 @@
   },
   "t-descriptions/column": {
     "type": "Number",
-    "description": "count of DescriptionItem in one row\n\n一行 `DescriptionItem` 的数量\n\ndefault: 2\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptions-props)"
+    "description": "count of DescriptionsItem in one row\n\n一行 `DescriptionsItem` 的数量\n\ndefault: 2\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptions-props)"
   },
   "t-descriptions/content-style": {
     "type": "Object",
@@ -2503,6 +2478,22 @@
     "type": "String|TNode",
     "description": "title of descriptions\n\n描述列表的标题\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptions-props)"
   },
+  "t-descriptions-item/content": {
+    "type": "String|TNode",
+    "description": "content of description item\n\n描述项内容\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionsitem-props)"
+  },
+  "t-descriptions-item/default": {
+    "type": "String|TNode",
+    "description": "content of description item\n\n描述项内容，同 `content`\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionsitem-props)"
+  },
+  "t-descriptions-item/label": {
+    "type": "String|TNode",
+    "description": "label of description item\n\n描述项标签\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionsitem-props)"
+  },
+  "t-descriptions-item/span": {
+    "type": "Number",
+    "description": "width count\n\n占用的宽度数量\n\ndefault: 1\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions?tab=api#descriptionsitem-props)"
+  },
   "t-dialog/attach": {
     "type": "String|Function",
     "description": "对话框挂载的节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body\n\n[docs](https://tdesign.tencent.com/vue-next/components/dialog?tab=api#dialog-props)"
diff --git a/packages/tdesign-vue-next/helper/tags.json b/packages/tdesign-vue-next/helper/tags.json
@@ -685,16 +685,6 @@
     ],
     "description": "DateRangePickerPanel\n\n日期范围选择器面板\n\n[docs](https://tdesign.tencent.com/vue-next/components/date-picker)"
   },
-  "t-description-item": {
-    "attributes": [
-      "align",
-      "content",
-      "default",
-      "label",
-      "span"
-    ],
-    "description": "DescriptionItem\n\n描述项\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions)"
-  },
   "t-descriptions": {
     "attributes": [
       "align",
@@ -712,6 +702,15 @@
     ],
     "description": "Descriptions\n\n描述列表\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions)"
   },
+  "t-descriptions-item": {
+    "attributes": [
+      "content",
+      "default",
+      "label",
+      "span"
+    ],
+    "description": "DescriptionsItem\n\n描述项\n\n[docs](https://tdesign.tencent.com/vue-next/components/descriptions)"
+  },
   "t-dialog": {
     "attributes": [
       "attach",
diff --git a/packages/tdesign-vue-next/helper/web-types.json b/packages/tdesign-vue-next/helper/web-types.json
