Merge branch 'main' into rss1102/feat/swiper/navigation

Author: RSS1102

.github/workflows/pr-spell-check.yml

@@ -0,0 +1,6 @@
+name: pr-spell-check
+on: [pull_request]
+
+jobs:
+  run:
+    uses: TDesignOteam/workflows/.github/workflows/spell-check.yml@main

.github/workflows/pr-spelling.template.yml

@@ -10,10 +10,10 @@ style | Object | - | CSS(Cascading Style Sheets) | N
 custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
 check-strictly | Boolean | false | \- | N
 close-btn | Boolean | true | \- | N
-keys | Object | - | Typescript：`KeysType`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
-options | Array | [] | Typescript：`Array<CascaderOption>` | N
+keys | Object | - | Typescript: `CascaderKeysType` `type CascaderKeysType = TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/cascader/type.ts) | N
+options | Array | [] | Typescript: `Array<CascaderOption>` | N
 placeholder | String | 选择选项 | \- | N
-sub-titles | Array | [] | Typescript：`Array<string>` | N
+sub-titles | Array | [] | Typescript: `Array<string>` | N
 theme | String | step | options: step/tab | N
 title | String | - | \- | N
 value | String / Number | null | \- | N

db/TDesign.db

@@ -10,7 +10,7 @@ style | Object | - | 样式 | N
 custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
 check-strictly | Boolean | false | 父子节点选中状态不再关联，可各自选中或取消 | N
 close-btn | Boolean | true | 关闭按钮 | N
-keys | Object | - | 用来定义 value / label 在 `options` 中对应的字段别名。TS 类型：`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+keys | Object | - | 用来定义 value / label / children / disabled 在 `options` 中对应的字段别名。TS 类型：`CascaderKeysType` `type CascaderKeysType = TreeKeysType`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/cascader/type.ts) | N
 options | Array | [] | 可选项数据源。TS 类型：`Array<CascaderOption>` | N
 placeholder | String | 选择选项 | 未选中时的提示文案 | N
 sub-titles | Array | [] | 每级展示的次标题。TS 类型：`Array<string>` | N

packages/products/tdesign-miniprogram/packages/components/cascader/README.en-US.md

@@ -16,7 +16,7 @@ const props: TdCascaderProps = {
     type: Boolean,
     value: true,
   },
-  /** 用来定义 value / label 在 `options` 中对应的字段别名 */
+  /** 用来定义 value / label / children / disabled 在 `options` 中对应的字段别名 */
   keys: {
     type: Object,
   },

packages/products/tdesign-miniprogram/packages/components/cascader/README.md

@@ -4,7 +4,7 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
-import { TreeOptionData, KeysType } from '../common/common';
+import { TreeOptionData, TreeKeysType } from '../common/common';
 
 export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOptionData> {
   /**
@@ -24,11 +24,11 @@ export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOpt
     value?: boolean;
   };
   /**
-   * 用来定义 value / label 在 `options` 中对应的字段别名
+   * 用来定义 value / label / children / disabled 在 `options` 中对应的字段别名
    */
   keys?: {
     type: ObjectConstructor;
-    value?: KeysType;
+    value?: CascaderKeysType;
   };
   /**
    * 可选项数据源
@@ -94,3 +94,5 @@ export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOpt
     value?: boolean;
   };
 }
+
+export type CascaderKeysType = TreeKeysType;

packages/products/tdesign-miniprogram/packages/components/cascader/props.ts

@@ -6,9 +6,6 @@ export interface Styles {
 
 export type ImageEvent = any;
 
-/**
- * 通用全局类型
- * */
 export type PlainObject = { [key: string]: any };
 
 export type OptionData = {
@@ -19,15 +16,18 @@ export type OptionData = {
 export type TreeOptionData<T = string | number> = {
   children?: Array<TreeOptionData<T>> | boolean;
   /** option label content */
-  label?: string | TNode;
+  label?: string;
   /** option search text */
   text?: string;
   /** option value */
   value?: T;
   /** option node content */
-  content?: string | TNode;
+  content?: string;
 } & PlainObject;
 
+/**
+ * 通用全局类型
+ * */
 export type SizeEnum = 'small' | 'medium' | 'large';
 
 export type ShapeEnum = 'circle' | 'round';

packages/products/tdesign-miniprogram/packages/components/cascader/type.ts

@@ -0,0 +1,22 @@
+:: BASE_DOC ::
+
+## API
+
+### Attachments Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+style | Object | - | CSS(Cascading Style Sheets) | N
+custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
+addable | Boolean | true | \- | N
+image-viewer | Boolean | true | \- | N
+items | Array | [] | Typescript: `FileItem[]` `interface FileItem { fileType: 'image'\|'video'\|'audio'\|'pdf'\|'doc'\|'ppt'\|'txt'; name: string; url: string; size: number; status?: 'success'\|'fail'\|'pending'\|'error'; progress?: number; errorMessage?: string; fileIcon?: string; width?: number; height?: number; mode?: 'aspectFit' \| 'aspectFill' \| 'widthFix' \| 'heightFix' \| 'scaleToFill'}`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/attachments/type.ts) | N
+removable | Boolean | true | \- | N
+
+### Attachments Events
+
+name | params | description
+-- | -- | --
+add | \- | \-
+file-click | `(item: FileItem)` | \-
+remove | `(item: FileItem, index: number)` | \-

packages/products/tdesign-miniprogram/packages/components/common/common.ts

@@ -0,0 +1,22 @@
+:: BASE_DOC ::
+
+## API
+
+### Attachments Props
+
+名称 | 类型 | 默认值 | 描述 | 必传
+-- | -- | -- | -- | --
+style | Object | - | 样式 | N
+custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
+addable | Boolean | true | 【讨论中】是否显示添加按钮 | N
+image-viewer | Boolean | true | 是否启用图片预览功能 | N
+items | Array | [] | 【实验】附件列表。TS 类型：`FileItem[]` `interface FileItem { fileType: 'image'\|'video'\|'audio'\|'pdf'\|'doc'\|'ppt'\|'txt'; name: string; url: string; size: number; status?: 'success'\|'fail'\|'pending'\|'error'; progress?: number; errorMessage?: string; fileIcon?: string; width?: number; height?: number; mode?: 'aspectFit' \| 'aspectFill' \| 'widthFix' \| 'heightFix' \| 'scaleToFill'}`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/pro-components/chat/attachments/type.ts) | N
+removable | Boolean | true | 是否显示删除按钮 | N
+
+### Attachments Events
+
+名称 | 参数 | 描述
+-- | -- | --
+add | \- | 点击添加按钮时触发
+file-click | `(item: FileItem)` | 点击文件时触发
+remove | `(item: FileItem, index: number)` | 点击删除按钮时触发