From 580a263b9a95fe948fa6882014ce8fa2d2eceffd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com> Date: Thu, 8 Aug 2024 21:59:47 +0800 Subject: [PATCH] feat(tag): update api --- db/TDesign.db | Bin 999424 -> 999424 bytes .../src/tag/defaultProps.ts | 24 +++ .../tdesign-mobile-react/src/tag/tag.en-US.md | 44 +++++ .../tdesign-mobile-react/src/tag/tag.md | 44 +++++ .../tdesign-mobile-react/src/tag/type.ts | 129 ++++++++++++ .../src/tag/check-tag-props.ts | 5 +- .../tdesign-mobile-vue/src/tag/tag.en-US.md | 4 +- .../tdesign-mobile-vue/src/tag/tag.md | 4 +- .../tdesign-react/src/tag/tag.en-US.md | 2 +- .../products/tdesign-react/src/tag/tag.md | 2 +- .../tdesign-vue-next/src/tag/tag.en-US.md | 4 +- .../products/tdesign-vue-next/src/tag/tag.md | 4 +- .../products/tdesign-vue/src/tag/tag.en-US.md | 4 +- packages/products/tdesign-vue/src/tag/tag.md | 4 +- packages/scripts/api.json | 186 +++--------------- 15 files changed, 281 insertions(+), 179 deletions(-) create mode 100644 packages/products/tdesign-mobile-react/src/tag/defaultProps.ts create mode 100644 packages/products/tdesign-mobile-react/src/tag/tag.en-US.md create mode 100644 packages/products/tdesign-mobile-react/src/tag/tag.md create mode 100644 packages/products/tdesign-mobile-react/src/tag/type.ts diff --git a/db/TDesign.db b/db/TDesign.db index 335b81aff04dd9b81f8a55f9ca498d4b44858157..85a27b6243604c64bf8937a3a473df5fb09abf67 100644 GIT binary patch delta 419 zcmZo@ux)6togmG4b)t+j>s1E5c&*l5U7sT7obBrgM`vbQT z*KRIV&PklAOiLJ-Z&y)Zl4oRL(`HPZ?ykrbr_83^SlJpO#l$GfD9ORgYtF#YWN2*6 zz{|_Y!OOwGz`=Zgefo#Le5TX?nJ{xt&ro6#V^MhAFk$*zMW#sR#|;zP>y((b*C{b; zhcZ@7KiJHd+|FCUyq&j#B|w6)zCCUN3lOscF&hxGZ;zY6Vfq-TF#a*0Rr|SOP9Ww2 zV(#tdig`TR8QI&#fAee?|IPaBHLGd`*9F^~E5m{}MY80xkI`HA9;72APoEqsvaZII))dCADNKvx<(wJ#=kopF3*znPImVOB{ejzv zYd4oF=Oj*5rX`Hd+f@{paYK_$Qjxx0!gM7irbxB~FlYK(6K0v|97;@L?R82_+v}8= zwL=*LrXOtPOK#__VBXGK!4e?BSl%8tfdzub)?g zdokxqj;|a+>=)Pt*ygf+XF10_Z@WSRUkeipi#x-w?JJu2?lUnl6m9Qp<*SHdVPIeo zp3eG!PnCt)j;(95VZ*}h=O6IpGqF_9PM4hC_l!?!d(2}#J!T+3LvlNipD51gvHine HJ^?2HCm@MO diff --git a/packages/products/tdesign-mobile-react/src/tag/defaultProps.ts b/packages/products/tdesign-mobile-react/src/tag/defaultProps.ts new file mode 100644 index 000000000..d336e0b86 --- /dev/null +++ b/packages/products/tdesign-mobile-react/src/tag/defaultProps.ts @@ -0,0 +1,24 @@ +/** + * 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC + * */ + +import { TdTagProps, TdCheckTagProps } from './type'; + +export const tagDefaultProps: TdTagProps = { + closable: false, + disabled: false, + icon: undefined, + shape: 'square', + size: 'medium', + theme: 'default', + variant: 'dark', +}; + +export const checkTagDefaultProps: TdCheckTagProps = { + defaultChecked: undefined, + closable: false, + disabled: false, + shape: 'square', + size: 'medium', + variant: 'dark', +}; diff --git a/packages/products/tdesign-mobile-react/src/tag/tag.en-US.md b/packages/products/tdesign-mobile-react/src/tag/tag.en-US.md new file mode 100644 index 000000000..9f20d86a4 --- /dev/null +++ b/packages/products/tdesign-mobile-react/src/tag/tag.en-US.md @@ -0,0 +1,44 @@ +:: BASE_DOC :: + +## API + +### Tag Props + +name | type | default | description | required +-- | -- | -- | -- | -- +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets),Typescript:`React.CSSProperties` | N +children | TNode | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +closable | Boolean | false | \- | N +content | TNode | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +disabled | Boolean | false | \- | N +icon | TElement | undefined | Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +maxWidth | String / Number | - | \- | N +shape | String | square | options: square/round/mark | N +size | String | medium | options: small/medium/large/extra-large | N +theme | String | default | options: default/primary/warning/danger/success | N +variant | String | dark | options: dark/light/outline/light-outline | N +onClick | Function | | Typescript:`(context: { e: MouseEvent }) => void`
| N +onClose | Function | | Typescript:`(context: { e: MouseEvent }) => void`
| N + + +### CheckTag Props + +name | type | default | description | required +-- | -- | -- | -- | -- +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets),Typescript:`React.CSSProperties` | N +checked | Boolean | undefined | \- | N +defaultChecked | Boolean | undefined | uncontrolled property | N +children | TNode | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +closable | Boolean | false | \- | N +content | TNode | - | Typescript:`string \| number \| string[] \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +disabled | Boolean | false | \- | N +icon | TElement | - | Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +shape | String | square | options: square/round/mark | N +size | String | medium | options: small/medium/large。Typescript:`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +uncheckedProps | Object | - | used to set unchecked tag props。Typescript:`TdTagProps` | N +variant | String | dark | options: dark/light/outline/light-outline | N +onChange | Function | | Typescript:`(checked: boolean) => void`
| N +onClick | Function | | Typescript:`(context: { e: MouseEvent }) => void`
| N +onClose | Function | | Typescript:`(context: { e: MouseEvent }) => void`
| N diff --git a/packages/products/tdesign-mobile-react/src/tag/tag.md b/packages/products/tdesign-mobile-react/src/tag/tag.md new file mode 100644 index 000000000..c26f2ad89 --- /dev/null +++ b/packages/products/tdesign-mobile-react/src/tag/tag.md @@ -0,0 +1,44 @@ +:: BASE_DOC :: + +## API + +### Tag Props + +名称 | 类型 | 默认值 | 描述 | 必传 +-- | -- | -- | -- | -- +className | String | - | 类名 | N +style | Object | - | 样式,TS 类型:`React.CSSProperties` | N +children | TNode | - | 组件子元素,同 `content`。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +closable | Boolean | false | 标签是否可关闭 | N +content | TNode | - | 组件子元素。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +disabled | Boolean | false | 标签禁用态,失效标签不能触发事件。默认风格(theme=default)才有禁用态 | N +icon | TElement | undefined | 标签中的图标,可自定义图标呈现。TS 类型:`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +maxWidth | String / Number | - | 标签最大宽度,宽度超出后会出现省略号。示例:'50px' / 80 | N +shape | String | square | 标签类型,有三种:方形、圆角方形、标记型。可选项:square/round/mark | N +size | String | medium | 标签尺寸。可选项:small/medium/large/extra-large | N +theme | String | default | 组件风格,用于描述组件不同的应用场景。可选项:default/primary/warning/danger/success | N +variant | String | dark | 标签风格变体。可选项:dark/light/outline/light-outline | N +onClick | Function | | TS 类型:`(context: { e: MouseEvent }) => void`
点击时触发 | N +onClose | Function | | TS 类型:`(context: { e: MouseEvent }) => void`
如果关闭按钮存在,点击关闭按钮时触发 | N + + +### CheckTag Props + +名称 | 类型 | 默认值 | 描述 | 必传 +-- | -- | -- | -- | -- +className | String | - | 类名 | N +style | Object | - | 样式,TS 类型:`React.CSSProperties` | N +checked | Boolean | undefined | 标签选中的状态,默认风格(theme=default)才有选中态 | N +defaultChecked | Boolean | undefined | 标签选中的状态,默认风格(theme=default)才有选中态。非受控属性 | N +children | TNode | - | 组件子元素。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +closable | Boolean | false | 标签是否可关闭 | N +content | TNode | - | 组件子元素;传入数组时:[选中内容,非选中内容]。TS 类型:`string \| number \| string[] \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +disabled | Boolean | false | 标签禁用态,失效标签不能触发事件。默认风格(theme=default)才有禁用态 | N +icon | TElement | - | 标签中的图标,可自定义图标呈现。TS 类型:`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +shape | String | square | 标签类型,有三种:方形、圆角方形、标记型。可选项:square/round/mark | N +size | String | medium | 标签尺寸。可选项:small/medium/large。TS 类型:`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N +uncheckedProps | Object | - | 透传标签未选态属性。TS 类型:`TdTagProps` | N +variant | String | dark | 标签风格变体。可选项:dark/light/outline/light-outline | N +onChange | Function | | TS 类型:`(checked: boolean) => void`
状态切换时触发 | N +onClick | Function | | TS 类型:`(context: { e: MouseEvent }) => void`
点击标签时触发 | N +onClose | Function | | TS 类型:`(context: { e: MouseEvent }) => void`
如果关闭按钮存在,点击关闭按钮时触发 | N diff --git a/packages/products/tdesign-mobile-react/src/tag/type.ts b/packages/products/tdesign-mobile-react/src/tag/type.ts new file mode 100644 index 000000000..ee6c17c55 --- /dev/null +++ b/packages/products/tdesign-mobile-react/src/tag/type.ts @@ -0,0 +1,129 @@ +/* eslint-disable */ + +/** + * 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC + * */ + +import { TNode, TElement, SizeEnum } from '../common'; +import { MouseEvent } from 'react'; + +export interface TdTagProps { + /** + * 组件子元素,同 `content` + */ + children?: TNode; + /** + * 标签是否可关闭 + * @default false + */ + closable?: boolean; + /** + * 组件子元素 + */ + content?: TNode; + /** + * 标签禁用态,失效标签不能触发事件。默认风格(theme=default)才有禁用态 + * @default false + */ + disabled?: boolean; + /** + * 标签中的图标,可自定义图标呈现 + */ + icon?: TElement; + /** + * 标签最大宽度,宽度超出后会出现省略号。示例:'50px' / 80 + */ + maxWidth?: string | number; + /** + * 标签类型,有三种:方形、圆角方形、标记型 + * @default square + */ + shape?: 'square' | 'round' | 'mark'; + /** + * 标签尺寸 + * @default medium + */ + size?: 'small' | 'medium' | 'large' | 'extra-large'; + /** + * 组件风格,用于描述组件不同的应用场景 + * @default default + */ + theme?: 'default' | 'primary' | 'warning' | 'danger' | 'success'; + /** + * 标签风格变体 + * @default dark + */ + variant?: 'dark' | 'light' | 'outline' | 'light-outline'; + /** + * 点击时触发 + */ + onClick?: (context: { e: MouseEvent }) => void; + /** + * 如果关闭按钮存在,点击关闭按钮时触发 + */ + onClose?: (context: { e: MouseEvent }) => void; +} + +export interface TdCheckTagProps { + /** + * 标签选中的状态,默认风格(theme=default)才有选中态 + */ + checked?: boolean; + /** + * 标签选中的状态,默认风格(theme=default)才有选中态,非受控属性 + */ + defaultChecked?: boolean; + /** + * 组件子元素 + */ + children?: TNode; + /** + * 标签是否可关闭 + * @default false + */ + closable?: boolean; + /** + * 组件子元素;传入数组时:[选中内容,非选中内容] + */ + content?: [] | TNode; + /** + * 标签禁用态,失效标签不能触发事件。默认风格(theme=default)才有禁用态 + * @default false + */ + disabled?: boolean; + /** + * 标签中的图标,可自定义图标呈现 + */ + icon?: TElement; + /** + * 标签类型,有三种:方形、圆角方形、标记型 + * @default square + */ + shape?: 'square' | 'round' | 'mark'; + /** + * 标签尺寸 + * @default medium + */ + size?: SizeEnum; + /** + * 透传标签未选态属性 + */ + uncheckedProps?: TdTagProps; + /** + * 标签风格变体 + * @default dark + */ + variant?: 'dark' | 'light' | 'outline' | 'light-outline'; + /** + * 状态切换时触发 + */ + onChange?: (checked: boolean) => void; + /** + * 点击标签时触发 + */ + onClick?: (context: { e: MouseEvent }) => void; + /** + * 如果关闭按钮存在,点击关闭按钮时触发 + */ + onClose?: (context: { e: MouseEvent }) => void; +} diff --git a/packages/products/tdesign-mobile-vue/src/tag/check-tag-props.ts b/packages/products/tdesign-mobile-vue/src/tag/check-tag-props.ts index b7ac805a1..788c75872 100644 --- a/packages/products/tdesign-mobile-vue/src/tag/check-tag-props.ts +++ b/packages/products/tdesign-mobile-vue/src/tag/check-tag-props.ts @@ -18,7 +18,10 @@ export default { default: undefined, }, /** 标签选中的状态,默认风格(theme=default)才有选中态,非受控属性 */ - defaultChecked: Boolean, + defaultChecked: { + type: Boolean, + default: undefined, + }, /** 标签是否可关闭 */ closable: Boolean, /** 组件子元素;传入数组时:[选中内容,非选中内容] */ diff --git a/packages/products/tdesign-mobile-vue/src/tag/tag.en-US.md b/packages/products/tdesign-mobile-vue/src/tag/tag.en-US.md index 47a4d8fcf..59ba6743c 100644 --- a/packages/products/tdesign-mobile-vue/src/tag/tag.en-US.md +++ b/packages/products/tdesign-mobile-vue/src/tag/tag.en-US.md @@ -31,8 +31,8 @@ close | `(context: { e: MouseEvent })` | \- name | type | default | description | required -- | -- | -- | -- | -- -checked | Boolean | - | `v-model` and `v-model:checked` is supported | N -defaultChecked | Boolean | - | uncontrolled property | N +checked | Boolean | undefined | `v-model` and `v-model:checked` is supported | N +defaultChecked | Boolean | undefined | uncontrolled property | N closable | Boolean | false | \- | N content | String / Number / Array / Slot / Function | - | Typescript:`string \| number \| string[] \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N default | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N diff --git a/packages/products/tdesign-mobile-vue/src/tag/tag.md b/packages/products/tdesign-mobile-vue/src/tag/tag.md index 4a6854774..a63bcfe5b 100644 --- a/packages/products/tdesign-mobile-vue/src/tag/tag.md +++ b/packages/products/tdesign-mobile-vue/src/tag/tag.md @@ -31,8 +31,8 @@ close | `(context: { e: MouseEvent })` | 如果关闭按钮存在,点击关闭 名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- -checked | Boolean | - | 标签选中的状态,默认风格(theme=default)才有选中态。支持语法糖 `v-model` 或 `v-model:checked` | N -defaultChecked | Boolean | - | 标签选中的状态,默认风格(theme=default)才有选中态。非受控属性 | N +checked | Boolean | undefined | 标签选中的状态,默认风格(theme=default)才有选中态。支持语法糖 `v-model` 或 `v-model:checked` | N +defaultChecked | Boolean | undefined | 标签选中的状态,默认风格(theme=default)才有选中态。非受控属性 | N closable | Boolean | false | 标签是否可关闭 | N content | String / Number / Array / Slot / Function | - | 组件子元素;传入数组时:[选中内容,非选中内容]。TS 类型:`string \| number \| string[] \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N default | String / Slot / Function | - | 组件子元素,默认插槽。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N diff --git a/packages/products/tdesign-react/src/tag/tag.en-US.md b/packages/products/tdesign-react/src/tag/tag.en-US.md index dbfc145bc..e1339a13b 100644 --- a/packages/products/tdesign-react/src/tag/tag.en-US.md +++ b/packages/products/tdesign-react/src/tag/tag.en-US.md @@ -38,7 +38,7 @@ disabled | Boolean | false | \- | N size | String | medium | options: small/medium/large。Typescript:`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N uncheckedProps | Object | - | used to set unchecked tag props。Typescript:`TdTagProps` | N value | String / Number | - | tag unique key | N -onChange | Function | | Typescript:`(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +onChange | Function | | Typescript:`(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N onClick | Function | | Typescript:`(context: { e: MouseEvent }) => void`
| N diff --git a/packages/products/tdesign-react/src/tag/tag.md b/packages/products/tdesign-react/src/tag/tag.md index 7d2d6ddb7..44386b83d 100644 --- a/packages/products/tdesign-react/src/tag/tag.md +++ b/packages/products/tdesign-react/src/tag/tag.md @@ -38,7 +38,7 @@ disabled | Boolean | false | 标签禁用态,失效标签不能触发事件。 size | String | medium | 标签尺寸。可选项:small/medium/large。TS 类型:`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N uncheckedProps | Object | - | 透传标签未选态属性。TS 类型:`TdTagProps` | N value | String / Number | - | 标签唯一标识,一般用于标签组场景,单个可选择标签无需设置 | N -onChange | Function | | TS 类型:`(checked: boolean, context: CheckTagChangeContext) => void`
状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +onChange | Function | | TS 类型:`(checked: boolean, context: CheckTagChangeContext) => void`
状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N onClick | Function | | TS 类型:`(context: { e: MouseEvent }) => void`
点击标签时触发 | N diff --git a/packages/products/tdesign-vue-next/src/tag/tag.en-US.md b/packages/products/tdesign-vue-next/src/tag/tag.en-US.md index 27ff5e902..778a974fa 100644 --- a/packages/products/tdesign-vue-next/src/tag/tag.en-US.md +++ b/packages/products/tdesign-vue-next/src/tag/tag.en-US.md @@ -41,14 +41,14 @@ disabled | Boolean | false | \- | N size | String | medium | options: small/medium/large。Typescript:`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N uncheckedProps | Object | - | used to set unchecked tag props。Typescript:`TdTagProps` | N value | String / Number | - | tag unique key | N -onChange | Function | | Typescript:`(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +onChange | Function | | Typescript:`(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N onClick | Function | | Typescript:`(context: { e: MouseEvent }) => void`
| N ### CheckTag Events name | params | description -- | -- | -- -change | `(checked: boolean, context: CheckTagChangeContext)` | [see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
+change | `(checked: boolean, context: CheckTagChangeContext) ` | [see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
click | `(context: { e: MouseEvent })` | \- diff --git a/packages/products/tdesign-vue-next/src/tag/tag.md b/packages/products/tdesign-vue-next/src/tag/tag.md index 8ce173987..e78554dec 100644 --- a/packages/products/tdesign-vue-next/src/tag/tag.md +++ b/packages/products/tdesign-vue-next/src/tag/tag.md @@ -41,14 +41,14 @@ disabled | Boolean | false | 标签禁用态,失效标签不能触发事件。 size | String | medium | 标签尺寸。可选项:small/medium/large。TS 类型:`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N uncheckedProps | Object | - | 透传标签未选态属性。TS 类型:`TdTagProps` | N value | String / Number | - | 标签唯一标识,一般用于标签组场景,单个可选择标签无需设置 | N -onChange | Function | | TS 类型:`(checked: boolean, context: CheckTagChangeContext) => void`
状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +onChange | Function | | TS 类型:`(checked: boolean, context: CheckTagChangeContext) => void`
状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N onClick | Function | | TS 类型:`(context: { e: MouseEvent }) => void`
点击标签时触发 | N ### CheckTag Events 名称 | 参数 | 描述 -- | -- | -- -change | `(checked: boolean, context: CheckTagChangeContext)` | 状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
+change | `(checked: boolean, context: CheckTagChangeContext) ` | 状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
click | `(context: { e: MouseEvent })` | 点击标签时触发 diff --git a/packages/products/tdesign-vue/src/tag/tag.en-US.md b/packages/products/tdesign-vue/src/tag/tag.en-US.md index 69250c8e6..a0502bc78 100644 --- a/packages/products/tdesign-vue/src/tag/tag.en-US.md +++ b/packages/products/tdesign-vue/src/tag/tag.en-US.md @@ -41,14 +41,14 @@ disabled | Boolean | false | \- | N size | String | medium | options: small/medium/large。Typescript:`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N uncheckedProps | Object | - | used to set unchecked tag props。Typescript:`TdTagProps` | N value | String / Number | - | tag unique key | N -onChange | Function | | Typescript:`(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +onChange | Function | | Typescript:`(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N onClick | Function | | Typescript:`(context: { e: MouseEvent }) => void`
| N ### CheckTag Events name | params | description -- | -- | -- -change | `(checked: boolean, context: CheckTagChangeContext)` | [see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
+change | `(checked: boolean, context: CheckTagChangeContext) ` | [see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
click | `(context: { e: MouseEvent })` | \- diff --git a/packages/products/tdesign-vue/src/tag/tag.md b/packages/products/tdesign-vue/src/tag/tag.md index 9a718633f..56c1a35ba 100644 --- a/packages/products/tdesign-vue/src/tag/tag.md +++ b/packages/products/tdesign-vue/src/tag/tag.md @@ -41,14 +41,14 @@ disabled | Boolean | false | 标签禁用态,失效标签不能触发事件。 size | String | medium | 标签尺寸。可选项:small/medium/large。TS 类型:`SizeEnum`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N uncheckedProps | Object | - | 透传标签未选态属性。TS 类型:`TdTagProps` | N value | String / Number | - | 标签唯一标识,一般用于标签组场景,单个可选择标签无需设置 | N -onChange | Function | | TS 类型:`(checked: boolean, context: CheckTagChangeContext) => void`
状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +onChange | Function | | TS 类型:`(checked: boolean, context: CheckTagChangeContext) => void`
状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N onClick | Function | | TS 类型:`(context: { e: MouseEvent }) => void`
点击标签时触发 | N ### CheckTag Events 名称 | 参数 | 描述 -- | -- | -- -change | `(checked: boolean, context: CheckTagChangeContext)` | 状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
+change | `(checked: boolean, context: CheckTagChangeContext) ` | 状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
click | `(context: { e: MouseEvent })` | 点击标签时触发 diff --git a/packages/scripts/api.json b/packages/scripts/api.json index 9a4c7f568..54ec55c23 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -24118,6 +24118,7 @@ "1", "2", "4", + "8", "16", "32", "64" @@ -24151,6 +24152,7 @@ "Vue(PC)", "React(PC)", "Angular(PC)", + "Vue(Mobile)", "React(Mobile)", "Angular(Mobile)", "Miniprogram" @@ -24159,51 +24161,12 @@ "Boolean" ] }, - { - "id": 1712664425, - "platform_framework": [ - "8" - ], - "component": "CheckTag", - "field_category": 1, - "field_name": "checked", - "field_type": [ - "4" - ], - "field_default_value": "", - "field_enum": "", - "field_desc_zh": "标签选中的状态,默认风格(theme=default)才有选中态", - "field_desc_en": null, - "field_required": 0, - "event_input": "", - "create_time": "2024-04-09 12:07:05", - "update_time": "2024-04-09 12:07:05", - "event_output": null, - "custom_field_type": null, - "syntactic_sugar": "v-model", - "readonly": 1, - "html_attribute": 0, - "trigger_elements": "", - "deprecated": 0, - "version": "", - "test_description": null, - "support_default_value": 1, - "field_category_text": "Props", - "platform_framework_text": [ - "Vue(Mobile)" - ], - "field_type_text": [ - "Boolean" - ] - }, { "id": 1695545685, "platform_framework": [ "1", "2", - "4", - "16", - "32" + "4" ], "component": "CheckTag", "field_category": 1, @@ -24233,9 +24196,7 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)", - "React(Mobile)", - "Angular(Mobile)" + "Angular(PC)" ], "field_type_text": [ "Object" @@ -24596,7 +24557,9 @@ { "id": 1490, "platform_framework": [ + "8", "16", + "32", "64" ], "component": "CheckTag", @@ -24625,50 +24588,15 @@ "support_default_value": 0, "field_category_text": "Props", "platform_framework_text": [ + "Vue(Mobile)", "React(Mobile)", + "Angular(Mobile)", "Miniprogram" ], "field_type_text": [ "String" ] }, - { - "id": 1712664487, - "platform_framework": [ - "8" - ], - "component": "CheckTag", - "field_category": 1, - "field_name": "shape", - "field_type": [ - "1" - ], - "field_default_value": "square", - "field_enum": "square/round/mark", - "field_desc_zh": "标签类型,有三种:方形、圆角方形、标记型", - "field_desc_en": null, - "field_required": 0, - "event_input": "", - "create_time": "2024-04-09 12:08:07", - "update_time": "2024-04-09 12:08:07", - "event_output": null, - "custom_field_type": null, - "syntactic_sugar": null, - "readonly": 1, - "html_attribute": 0, - "trigger_elements": "", - "deprecated": 0, - "version": "", - "test_description": null, - "support_default_value": 0, - "field_category_text": "Props", - "platform_framework_text": [ - "Vue(Mobile)" - ], - "field_type_text": [ - "String" - ] - }, { "id": 1487, "platform_framework": [ @@ -24854,9 +24782,7 @@ "platform_framework": [ "1", "2", - "4", - "16", - "32" + "4" ], "component": "CheckTag", "field_category": 2, @@ -24864,14 +24790,14 @@ "field_type": [], "field_default_value": "", "field_enum": "", - "field_desc_zh": "状态切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent | KeyboardEvent; value: string | number }`
", + "field_desc_zh": "状态切换时触发", "field_desc_en": null, "field_required": 0, - "event_input": "(checked: boolean, context: CheckTagChangeContext)", + "event_input": "(checked: boolean, context: CheckTagChangeContext) 【interface CheckTagChangeContext { e: MouseEvent | KeyboardEvent; value: string | number }】", "create_time": "2021-02-20 12:58:23", "update_time": "2021-11-27 15:47:10", "event_output": null, - "custom_field_type": null, + "custom_field_type": "", "syntactic_sugar": "", "readonly": 1, "html_attribute": 0, @@ -24884,9 +24810,7 @@ "platform_framework_text": [ "Vue(PC)", "React(PC)", - "Angular(PC)", - "React(Mobile)", - "Angular(Mobile)" + "Angular(PC)" ], "field_type_text": [] }, @@ -24894,6 +24818,8 @@ "id": 1712912084, "platform_framework": [ "8", + "16", + "32", "64" ], "component": "CheckTag", @@ -24921,6 +24847,8 @@ "field_category_text": "Events", "platform_framework_text": [ "Vue(Mobile)", + "React(Mobile)", + "Angular(Mobile)", "Miniprogram" ], "field_type_text": [] @@ -118469,8 +118397,10 @@ { "id": 3240, "platform_framework": [ + "8", "16", - "32" + "32", + "64" ], "component": "Tag", "field_category": 1, @@ -118498,87 +118428,15 @@ "support_default_value": 0, "field_category_text": "Props", "platform_framework_text": [ + "Vue(Mobile)", "React(Mobile)", - "Angular(Mobile)" - ], - "field_type_text": [ - "String" - ] - }, - { - "id": 1712653042, - "platform_framework": [ - "64" - ], - "component": "Tag", - "field_category": 1, - "field_name": "size", - "field_type": [ - "1" - ], - "field_default_value": "medium", - "field_enum": "small/medium/large/extra-large", - "field_desc_zh": "标签尺寸", - "field_desc_en": null, - "field_required": 0, - "event_input": "", - "create_time": "2024-04-09 08:57:22", - "update_time": "2024-04-09 08:57:22", - "event_output": null, - "custom_field_type": "", - "syntactic_sugar": null, - "readonly": 1, - "html_attribute": 0, - "trigger_elements": "", - "deprecated": 0, - "version": "", - "test_description": null, - "support_default_value": 0, - "field_category_text": "Props", - "platform_framework_text": [ + "Angular(Mobile)", "Miniprogram" ], "field_type_text": [ "String" ] }, - { - "id": 1712664388, - "platform_framework": [ - "8" - ], - "component": "Tag", - "field_category": 1, - "field_name": "size", - "field_type": [ - "1" - ], - "field_default_value": "medium", - "field_enum": "small/medium/large/extra-large", - "field_desc_zh": "标签尺寸", - "field_desc_en": null, - "field_required": 0, - "event_input": "", - "create_time": "2024-04-09 12:06:28", - "update_time": "2024-04-09 12:06:28", - "event_output": null, - "custom_field_type": "", - "syntactic_sugar": null, - "readonly": 1, - "html_attribute": 0, - "trigger_elements": "", - "deprecated": 0, - "version": "", - "test_description": null, - "support_default_value": 0, - "field_category_text": "Props", - "platform_framework_text": [ - "Vue(Mobile)" - ], - "field_type_text": [ - "String" - ] - }, { "id": 4, "platform_framework": [