From 77dad3fa553c190ac17f3c8c98882424fbe0763d Mon Sep 17 00:00:00 2001 From: novlan1 <1576271227@qq.com> Date: Thu, 13 Feb 2025 12:05:21 +0800 Subject: [PATCH 1/2] feat(mobile-borderless): support borderless props --- db/TDesign.db | Bin 1007616 -> 1007616 bytes .../checkbox-group/checkbox-group.en-US.md | 6 +++++- .../src/checkbox-group/checkbox-group.md | 8 ++++++-- .../src/checkbox/checkbox-group-props.ts | 2 ++ .../src/checkbox/checkbox.en-US.md | 2 ++ .../src/checkbox/checkbox.md | 2 ++ .../tdesign-mobile-vue/src/checkbox/props.ts | 2 ++ .../tdesign-mobile-vue/src/checkbox/type.ts | 10 ++++++++++ packages/scripts/api.json | 4 ++++ 9 files changed, 33 insertions(+), 3 deletions(-) diff --git a/db/TDesign.db b/db/TDesign.db index c017d39a0390428e80ae352cac71e927d88cc383..58132d3e5e040d7d490d036997abd1d728ffba7a 100644 GIT binary patch delta 95 zcmZoTVB2uOc7ilx%S0Jx))of6vW~`-))dCp6sFb`=GGLJ))dy(6t>nB_SO`R))dax y6t313?yV_2_h)ieIA^3LXD8)XOkcmB$8dV>EFL??jP^aVcz~F9`<_{RE=K`g2P4@4 delta 95 zcmZoTVB2uOc7ilx(?l6()+PqMvaZII))dCp6sFb`=GGLJ))dy(6t>nB_SO`R))dax y6t313?yV_2_h)hzIA^3LXD8)XOkcmB$8dV>EFL??g!VnNcz~F9`<_{RE=K`d!z0H4 diff --git a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md b/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md index 24b105742..331b02dee 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md +++ b/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md @@ -1,14 +1,18 @@ :: BASE_DOC :: ## API + ### CheckboxGroup Props name | type | default | description | required -- | -- | -- | -- | -- -disabled | Boolean | - | \- | N +borderless | Boolean | false | \- | N +disabled | Boolean | undefined | \- | N +keys | Object | - | Typescript:`KeysType`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N max | Number | undefined | \- | N name | String | - | \- | N options | Array | - | Typescript:`Array` `type CheckboxOption = string \| number \| CheckboxOptionObj` `interface CheckboxOptionObj extends TdCheckboxProps { text?: string; }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N +readonly | Boolean | undefined | \- | N value | Array | [] | `v-model` and `v-model:value` is supported。Typescript:`T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N defaultValue | Array | [] | uncontrolled property。Typescript:`T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N onChange | Function | | Typescript:`(value: T, context: CheckboxGroupChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: Event; current: string \| number; option: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
| N diff --git a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md b/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md index 6b03e7698..287295e29 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md +++ b/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md @@ -1,14 +1,18 @@ :: BASE_DOC :: ## API + ### CheckboxGroup Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- -disabled | Boolean | - | 是否禁用组件,默认为 false。CheckboxGroup.disabled 优先级低于 Checkbox.disabled | N +borderless | Boolean | false | 是否开启无边框模式 | N +disabled | Boolean | undefined | 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled | N +keys | Object | - | 用来定义 value / label / disabled 在 `options` 中对应的字段别名。TS 类型:`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N max | Number | undefined | 支持最多选中的数量 | N name | String | - | 统一设置内部复选框 HTML 属性 | N options | Array | - | 以配置形式设置子元素。示例1:`['北京', '上海']` ,示例2: `[{ label: '全选', checkAll: true }, { label: '上海', value: 'shanghai' }]`。checkAll 值为 true 表示当前选项为「全选选项」。TS 类型:`Array` `type CheckboxOption = string \| number \| CheckboxOptionObj` `interface CheckboxOptionObj extends TdCheckboxProps { text?: string; }`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N +readonly | Boolean | undefined | 只读状态 | N value | Array | [] | 选中值。支持语法糖 `v-model` 或 `v-model:value`。TS 类型:`T` `type CheckboxGroupValue = Array`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N defaultValue | Array | [] | 选中值。非受控属性。TS 类型:`T` `type CheckboxGroupValue = Array`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N onChange | Function | | TS 类型:`(value: T, context: CheckboxGroupChangeContext) => void`
值变化时触发。`context.current` 表示当前变化的数据项,如果是全选则为空;`context.type` 表示引起选中数据变化的是选中或是取消选中,`context.option` 表示当前变化的数据项。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: Event; current: string \| number; option: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
| N diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts index e25a5bb6a..b71729200 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts +++ b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts @@ -8,6 +8,8 @@ import { TdCheckboxGroupProps } from '../checkbox/type'; import { PropType } from 'vue'; export default { + /** 是否开启无边框模式 */ + borderless: Boolean, /** 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled */ disabled: { type: Boolean, diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md index 538447701..b1faafab6 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md +++ b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md @@ -7,6 +7,7 @@ name | type | default | description | required -- | -- | -- | -- | -- block | Boolean | true | \- | N +borderless | Boolean | false | \- | N checkAll | Boolean | false | \- | N checked | Boolean | false | `v-model` and `v-model:checked` is supported | N defaultChecked | Boolean | false | uncontrolled property | N @@ -36,6 +37,7 @@ change | `(checked: boolean, context: { e: Event })` | \- name | type | default | description | required -- | -- | -- | -- | -- +borderless | Boolean | false | \- | N disabled | Boolean | undefined | \- | N keys | Object | - | Typescript:`KeysType`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N max | Number | undefined | \- | N diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md index fcd72223e..cd49b0fbb 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md +++ b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md @@ -7,6 +7,7 @@ 名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- block | Boolean | true | 是否为块级元素 | N +borderless | Boolean | false | 是否开启无边框模式 | N checkAll | Boolean | false | 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 | N checked | Boolean | false | 是否选中。支持语法糖 `v-model` 或 `v-model:checked` | N defaultChecked | Boolean | false | 是否选中。非受控属性 | N @@ -36,6 +37,7 @@ change | `(checked: boolean, context: { e: Event })` | 值变化时触发 名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- +borderless | Boolean | false | 是否开启无边框模式 | N disabled | Boolean | undefined | 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled | N keys | Object | - | 用来定义 value / label / disabled 在 `options` 中对应的字段别名。TS 类型:`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N max | Number | undefined | 支持最多选中的数量 | N diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/props.ts b/packages/products/tdesign-mobile-vue/src/checkbox/props.ts index 4044a2eeb..06459808d 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/props.ts +++ b/packages/products/tdesign-mobile-vue/src/checkbox/props.ts @@ -13,6 +13,8 @@ export default { type: Boolean, default: true, }, + /** 是否开启无边框模式 */ + borderless: Boolean, /** 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 */ checkAll: Boolean, /** 是否选中 */ diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/type.ts b/packages/products/tdesign-mobile-vue/src/checkbox/type.ts index c567b7625..86624987a 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/type.ts +++ b/packages/products/tdesign-mobile-vue/src/checkbox/type.ts @@ -12,6 +12,11 @@ export interface TdCheckboxProps { * @default true */ block?: boolean; + /** + * 是否开启无边框模式 + * @default false + */ + borderless?: boolean; /** * 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 * @default false @@ -97,6 +102,11 @@ export interface TdCheckboxProps { } export interface TdCheckboxGroupProps { + /** + * 是否开启无边框模式 + * @default false + */ + borderless?: boolean; /** * 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled */ diff --git a/packages/scripts/api.json b/packages/scripts/api.json index db4eaf8e7..67fc04eed 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -25147,6 +25147,7 @@ { "id": 3522, "platform_framework": [ + "8", "16", "32", "64" @@ -25177,6 +25178,7 @@ "support_default_value": 0, "field_category_text": "Props", "platform_framework_text": [ + "Vue(Mobile)", "React(Mobile)", "Angular(Mobile)", "Miniprogram" @@ -26356,6 +26358,7 @@ { "id": 3521, "platform_framework": [ + "8", "32", "64" ], @@ -26385,6 +26388,7 @@ "support_default_value": 0, "field_category_text": "Props", "platform_framework_text": [ + "Vue(Mobile)", "Angular(Mobile)", "Miniprogram" ], From 01b61cb188a39faedefcdaad972ee5980192f7e5 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, 13 Feb 2025 16:20:54 +0800 Subject: [PATCH 2/2] feat(checkbox): update borderless default value to undefined --- db/TDesign.db | Bin 1007616 -> 1007616 bytes .../src/checkbox-group/props.ts | 2 +- .../src/checkbox-group/type.ts | 2 +- .../src/checkbox/README.en-US.md | 2 +- .../src/checkbox/README.md | 4 +-- .../tdesign-miniprogram/src/checkbox/props.ts | 4 +-- .../tdesign-miniprogram/src/checkbox/type.ts | 1 - .../src/checkbox/checkbox.en-US.md | 3 ++- .../src/checkbox/checkbox.md | 3 ++- .../src/checkbox/defaultProps.ts | 3 ++- .../tdesign-mobile-react/src/checkbox/type.ts | 6 ++++- .../checkbox-group/checkbox-group.en-US.md | 24 ------------------ .../src/checkbox-group/checkbox-group.md | 24 ------------------ .../src/checkbox/checkbox-group-props.ts | 2 +- .../src/checkbox/checkbox.en-US.md | 2 +- .../src/checkbox/checkbox.md | 4 +-- .../tdesign-mobile-vue/src/checkbox/props.ts | 5 +++- .../tdesign-mobile-vue/src/checkbox/type.ts | 3 +-- packages/scripts/api.json | 6 +++-- 19 files changed, 31 insertions(+), 69 deletions(-) delete mode 100644 packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md delete mode 100644 packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md diff --git a/db/TDesign.db b/db/TDesign.db index 58132d3e5e040d7d490d036997abd1d728ffba7a..e897bfd5904f0653b29c3102462c2d0bf1f6640a 100644 GIT binary patch delta 250 zcmZoTVB2uOc7ilx=R_H2#?Hos)&$1Z1g6#m=GFw3)&$np1h&=$_SOWB)&$Ph1g_Qu z?yU(tOZ&wcW0+Z8`1<%{c%6AR@pyAz delta 208 zcmV;>05AW5z&(J#J&+p#gpnLW0fd2Ig3;1BGA&gZ^0Rsg@4vr2S4MPmF3`+~v3mOWY3MIE3kPJWplR$u?1A%##w*it2 z_W}YBVz>H~3@Zf(b(T*V0s$SDkiQHSm%5q^7MHr83@Mj@nhYHWdX`QZ0s$wNkiQHS z0}a7wmwk~8IG5U=3?{c4n+#Du$p8 KhM*0mpbo%Ey+xJ) diff --git a/packages/products/tdesign-miniprogram/src/checkbox-group/props.ts b/packages/products/tdesign-miniprogram/src/checkbox-group/props.ts index 28490fdc9..6968000c3 100644 --- a/packages/products/tdesign-miniprogram/src/checkbox-group/props.ts +++ b/packages/products/tdesign-miniprogram/src/checkbox-group/props.ts @@ -6,7 +6,7 @@ import { TdCheckboxGroupProps } from './type'; const props: TdCheckboxGroupProps = { - /** 是否开启无边框模式 */ + /** 是否开启无边框模式。优先级低于 Checkbox.borderless */ borderless: { type: Boolean, value: false, diff --git a/packages/products/tdesign-miniprogram/src/checkbox-group/type.ts b/packages/products/tdesign-miniprogram/src/checkbox-group/type.ts index c4ff60532..9f0550df5 100644 --- a/packages/products/tdesign-miniprogram/src/checkbox-group/type.ts +++ b/packages/products/tdesign-miniprogram/src/checkbox-group/type.ts @@ -8,7 +8,7 @@ import { KeysType } from '../common/common'; export interface TdCheckboxGroupProps { /** - * 是否开启无边框模式 + * 是否开启无边框模式。优先级低于 Checkbox.borderless * @default false */ borderless?: { diff --git a/packages/products/tdesign-miniprogram/src/checkbox/README.en-US.md b/packages/products/tdesign-miniprogram/src/checkbox/README.en-US.md index 7646592c4..8b3bfdf1d 100644 --- a/packages/products/tdesign-miniprogram/src/checkbox/README.en-US.md +++ b/packages/products/tdesign-miniprogram/src/checkbox/README.en-US.md @@ -9,7 +9,7 @@ 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 block | Boolean | true | \- | N -borderless | Boolean | false | \- | N +borderless | Boolean | undefined | \- | N check-all | Boolean | false | \- | N checked | Boolean | false | \- | N default-checked | Boolean | undefined | uncontrolled property | N diff --git a/packages/products/tdesign-miniprogram/src/checkbox/README.md b/packages/products/tdesign-miniprogram/src/checkbox/README.md index de0aa73db..ea561790d 100644 --- a/packages/products/tdesign-miniprogram/src/checkbox/README.md +++ b/packages/products/tdesign-miniprogram/src/checkbox/README.md @@ -9,7 +9,7 @@ style | Object | - | 样式 | N custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N block | Boolean | true | 是否为块级元素 | N -borderless | Boolean | false | 是否开启无边框模式 | N +borderless | Boolean | undefined | 是否开启无边框模式 | N check-all | Boolean | false | 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 | N checked | Boolean | false | 是否选中 | N default-checked | Boolean | undefined | 是否选中。非受控属性 | N @@ -49,7 +49,7 @@ t-class-label | 标签样式类 -- | -- | -- | -- | -- style | Object | - | 样式 | N custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N -borderless | Boolean | false | 是否开启无边框模式 | N +borderless | Boolean | false | 是否开启无边框模式。优先级低于 Checkbox.borderless | N disabled | Boolean | undefined | 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled | N keys | Object | - | 用来定义 value / label / disabled 在 `options` 中对应的字段别名。TS 类型:`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N max | Number | undefined | 支持最多选中的数量 | N diff --git a/packages/products/tdesign-miniprogram/src/checkbox/props.ts b/packages/products/tdesign-miniprogram/src/checkbox/props.ts index 86a12d2ab..9b1ac3a49 100644 --- a/packages/products/tdesign-miniprogram/src/checkbox/props.ts +++ b/packages/products/tdesign-miniprogram/src/checkbox/props.ts @@ -13,8 +13,8 @@ const props: TdCheckboxProps = { }, /** 是否开启无边框模式 */ borderless: { - type: Boolean, - value: false, + type: null, + value: undefined, }, /** 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 */ checkAll: { diff --git a/packages/products/tdesign-miniprogram/src/checkbox/type.ts b/packages/products/tdesign-miniprogram/src/checkbox/type.ts index 219f74689..479bb3e69 100644 --- a/packages/products/tdesign-miniprogram/src/checkbox/type.ts +++ b/packages/products/tdesign-miniprogram/src/checkbox/type.ts @@ -15,7 +15,6 @@ export interface TdCheckboxProps { }; /** * 是否开启无边框模式 - * @default false */ borderless?: { type: BooleanConstructor; diff --git a/packages/products/tdesign-mobile-react/src/checkbox/checkbox.en-US.md b/packages/products/tdesign-mobile-react/src/checkbox/checkbox.en-US.md index f6ebef2db..8de9f18aa 100644 --- a/packages/products/tdesign-mobile-react/src/checkbox/checkbox.en-US.md +++ b/packages/products/tdesign-mobile-react/src/checkbox/checkbox.en-US.md @@ -9,7 +9,7 @@ name | type | default | description | required className | String | - | className of component | N style | Object | - | CSS(Cascading Style Sheets),Typescript:`React.CSSProperties` | N block | Boolean | true | \- | N -borderless | Boolean | false | \- | N +borderless | Boolean | undefined | \- | N checkAll | Boolean | false | \- | N checked | Boolean | false | \- | N defaultChecked | Boolean | false | uncontrolled property | N @@ -35,6 +35,7 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N style | Object | - | CSS(Cascading Style Sheets),Typescript:`React.CSSProperties` | N +borderless | Boolean | false | \- | N disabled | Boolean | undefined | \- | N keys | Object | - | Typescript:`KeysType`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N max | Number | undefined | \- | N diff --git a/packages/products/tdesign-mobile-react/src/checkbox/checkbox.md b/packages/products/tdesign-mobile-react/src/checkbox/checkbox.md index fff7d08ed..fbb5cf4b4 100644 --- a/packages/products/tdesign-mobile-react/src/checkbox/checkbox.md +++ b/packages/products/tdesign-mobile-react/src/checkbox/checkbox.md @@ -9,7 +9,7 @@ className | String | - | 类名 | N style | Object | - | 样式,TS 类型:`React.CSSProperties` | N block | Boolean | true | 是否为块级元素 | N -borderless | Boolean | false | 是否开启无边框模式 | N +borderless | Boolean | undefined | 是否开启无边框模式 | N checkAll | Boolean | false | 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 | N checked | Boolean | false | 是否选中 | N defaultChecked | Boolean | false | 是否选中。非受控属性 | N @@ -35,6 +35,7 @@ onChange | Function | | TS 类型:`(checked: boolean, context: { e: ChangeEve -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式,TS 类型:`React.CSSProperties` | N +borderless | Boolean | false | 是否开启无边框模式。优先级低于 Checkbox.borderless | N disabled | Boolean | undefined | 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled | N keys | Object | - | 用来定义 value / label / disabled 在 `options` 中对应的字段别名。TS 类型:`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N max | Number | undefined | 支持最多选中的数量 | N diff --git a/packages/products/tdesign-mobile-react/src/checkbox/defaultProps.ts b/packages/products/tdesign-mobile-react/src/checkbox/defaultProps.ts index 901302a97..c13e93ea9 100644 --- a/packages/products/tdesign-mobile-react/src/checkbox/defaultProps.ts +++ b/packages/products/tdesign-mobile-react/src/checkbox/defaultProps.ts @@ -6,7 +6,7 @@ import { TdCheckboxProps, TdCheckboxGroupProps } from './type'; export const checkboxDefaultProps: TdCheckboxProps = { block: true, - borderless: false, + borderless: undefined, checkAll: false, defaultChecked: false, disabled: undefined, @@ -19,6 +19,7 @@ export const checkboxDefaultProps: TdCheckboxProps = { }; export const checkboxGroupDefaultProps: TdCheckboxGroupProps = { + borderless: false, disabled: undefined, max: undefined, readonly: undefined, diff --git a/packages/products/tdesign-mobile-react/src/checkbox/type.ts b/packages/products/tdesign-mobile-react/src/checkbox/type.ts index 4e5094c39..e2c1fa539 100644 --- a/packages/products/tdesign-mobile-react/src/checkbox/type.ts +++ b/packages/products/tdesign-mobile-react/src/checkbox/type.ts @@ -15,7 +15,6 @@ export interface TdCheckboxProps { block?: boolean; /** * 是否开启无边框模式 - * @default false */ borderless?: boolean; /** @@ -98,6 +97,11 @@ export interface TdCheckboxProps { } export interface TdCheckboxGroupProps { + /** + * 是否开启无边框模式。优先级低于 Checkbox.borderless + * @default false + */ + borderless?: boolean; /** * 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled */ diff --git a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md b/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md deleted file mode 100644 index 331b02dee..000000000 --- a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.en-US.md +++ /dev/null @@ -1,24 +0,0 @@ -:: BASE_DOC :: - -## API - -### CheckboxGroup Props - -name | type | default | description | required --- | -- | -- | -- | -- -borderless | Boolean | false | \- | N -disabled | Boolean | undefined | \- | N -keys | Object | - | Typescript:`KeysType`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N -max | Number | undefined | \- | N -name | String | - | \- | N -options | Array | - | Typescript:`Array` `type CheckboxOption = string \| number \| CheckboxOptionObj` `interface CheckboxOptionObj extends TdCheckboxProps { text?: string; }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N -readonly | Boolean | undefined | \- | N -value | Array | [] | `v-model` and `v-model:value` is supported。Typescript:`T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N -defaultValue | Array | [] | uncontrolled property。Typescript:`T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N -onChange | Function | | Typescript:`(value: T, context: CheckboxGroupChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: Event; current: string \| number; option: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
| N - -### CheckboxGroup Events - -name | params | description --- | -- | -- -change | `(value: T, context: CheckboxGroupChangeContext)` | [see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: Event; current: string \| number; option: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
diff --git a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md b/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md deleted file mode 100644 index 287295e29..000000000 --- a/packages/products/tdesign-mobile-vue/src/checkbox-group/checkbox-group.md +++ /dev/null @@ -1,24 +0,0 @@ -:: BASE_DOC :: - -## API - -### CheckboxGroup Props - -名称 | 类型 | 默认值 | 描述 | 必传 --- | -- | -- | -- | -- -borderless | Boolean | false | 是否开启无边框模式 | N -disabled | Boolean | undefined | 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled | N -keys | Object | - | 用来定义 value / label / disabled 在 `options` 中对应的字段别名。TS 类型:`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N -max | Number | undefined | 支持最多选中的数量 | N -name | String | - | 统一设置内部复选框 HTML 属性 | N -options | Array | - | 以配置形式设置子元素。示例1:`['北京', '上海']` ,示例2: `[{ label: '全选', checkAll: true }, { label: '上海', value: 'shanghai' }]`。checkAll 值为 true 表示当前选项为「全选选项」。TS 类型:`Array` `type CheckboxOption = string \| number \| CheckboxOptionObj` `interface CheckboxOptionObj extends TdCheckboxProps { text?: string; }`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N -readonly | Boolean | undefined | 只读状态 | N -value | Array | [] | 选中值。支持语法糖 `v-model` 或 `v-model:value`。TS 类型:`T` `type CheckboxGroupValue = Array`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N -defaultValue | Array | [] | 选中值。非受控属性。TS 类型:`T` `type CheckboxGroupValue = Array`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts) | N -onChange | Function | | TS 类型:`(value: T, context: CheckboxGroupChangeContext) => void`
值变化时触发。`context.current` 表示当前变化的数据项,如果是全选则为空;`context.type` 表示引起选中数据变化的是选中或是取消选中,`context.option` 表示当前变化的数据项。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: Event; current: string \| number; option: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
| N - -### CheckboxGroup Events - -名称 | 参数 | 描述 --- | -- | -- -change | `(value: T, context: CheckboxGroupChangeContext)` | 值变化时触发。`context.current` 表示当前变化的数据项,如果是全选则为空;`context.type` 表示引起选中数据变化的是选中或是取消选中,`context.option` 表示当前变化的数据项。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: Event; current: string \| number; option: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts index b71729200..99ad7ef83 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts +++ b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox-group-props.ts @@ -8,7 +8,7 @@ import { TdCheckboxGroupProps } from '../checkbox/type'; import { PropType } from 'vue'; export default { - /** 是否开启无边框模式 */ + /** 是否开启无边框模式。优先级低于 Checkbox.borderless */ borderless: Boolean, /** 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled */ disabled: { diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md index b1faafab6..a6c917d85 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md +++ b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.en-US.md @@ -7,7 +7,7 @@ name | type | default | description | required -- | -- | -- | -- | -- block | Boolean | true | \- | N -borderless | Boolean | false | \- | N +borderless | Boolean | undefined | \- | N checkAll | Boolean | false | \- | N checked | Boolean | false | `v-model` and `v-model:checked` is supported | N defaultChecked | Boolean | false | uncontrolled property | N diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md index cd49b0fbb..31f81e24d 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md +++ b/packages/products/tdesign-mobile-vue/src/checkbox/checkbox.md @@ -7,7 +7,7 @@ 名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- block | Boolean | true | 是否为块级元素 | N -borderless | Boolean | false | 是否开启无边框模式 | N +borderless | Boolean | undefined | 是否开启无边框模式 | N checkAll | Boolean | false | 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 | N checked | Boolean | false | 是否选中。支持语法糖 `v-model` 或 `v-model:checked` | N defaultChecked | Boolean | false | 是否选中。非受控属性 | N @@ -37,7 +37,7 @@ change | `(checked: boolean, context: { e: Event })` | 值变化时触发 名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- -borderless | Boolean | false | 是否开启无边框模式 | N +borderless | Boolean | false | 是否开启无边框模式。优先级低于 Checkbox.borderless | N disabled | Boolean | undefined | 是否禁用组件。优先级:Form.disabled < CheckboxGroup.disabled < Checkbox.disabled | N keys | Object | - | 用来定义 value / label / disabled 在 `options` 中对应的字段别名。TS 类型:`KeysType`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N max | Number | undefined | 支持最多选中的数量 | N diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/props.ts b/packages/products/tdesign-mobile-vue/src/checkbox/props.ts index 06459808d..84f283dab 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/props.ts +++ b/packages/products/tdesign-mobile-vue/src/checkbox/props.ts @@ -14,7 +14,10 @@ export default { default: true, }, /** 是否开启无边框模式 */ - borderless: Boolean, + borderless: { + type: Boolean, + default: undefined, + }, /** 用于标识是否为「全选选项」。单独使用无效,需在 CheckboxGroup 中使用 */ checkAll: Boolean, /** 是否选中 */ diff --git a/packages/products/tdesign-mobile-vue/src/checkbox/type.ts b/packages/products/tdesign-mobile-vue/src/checkbox/type.ts index 86624987a..fb3aa2974 100644 --- a/packages/products/tdesign-mobile-vue/src/checkbox/type.ts +++ b/packages/products/tdesign-mobile-vue/src/checkbox/type.ts @@ -14,7 +14,6 @@ export interface TdCheckboxProps { block?: boolean; /** * 是否开启无边框模式 - * @default false */ borderless?: boolean; /** @@ -103,7 +102,7 @@ export interface TdCheckboxProps { export interface TdCheckboxGroupProps { /** - * 是否开启无边框模式 + * 是否开启无边框模式。优先级低于 Checkbox.borderless * @default false */ borderless?: boolean; diff --git a/packages/scripts/api.json b/packages/scripts/api.json index 67fc04eed..8066adc95 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -25158,7 +25158,7 @@ "field_type": [ "4" ], - "field_default_value": "false", + "field_default_value": "undefined", "field_enum": "", "field_desc_zh": "是否开启无边框模式", "field_desc_en": null, @@ -26359,6 +26359,7 @@ "id": 3521, "platform_framework": [ "8", + "16", "32", "64" ], @@ -26370,7 +26371,7 @@ ], "field_default_value": "false", "field_enum": "", - "field_desc_zh": "是否开启无边框模式", + "field_desc_zh": "是否开启无边框模式。优先级低于 Checkbox.borderless", "field_desc_en": null, "field_required": 0, "event_input": "", @@ -26389,6 +26390,7 @@ "field_category_text": "Props", "platform_framework_text": [ "Vue(Mobile)", + "React(Mobile)", "Angular(Mobile)", "Miniprogram" ],