Skip to content

Commit 4aea3b2

Browse files
novlan1novlan1
authored
feat(cascader): add overlayProps (#722)
1 parent e3d6a9b commit 4aea3b2

File tree

6 files changed

+58
-4
lines changed

6 files changed

+58
-4
lines changed

‎db/TDesign.db‎

0 Bytes
Binary file not shown.

‎packages/products/tdesign-mobile-vue/src/cascader/cascader.en-US.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ header | Slot / Function | - | Typescript：`TNode`。[see more ts definition](h
1212
keys | Object | - | Typescript：`CascaderKeysType` `type CascaderKeysType = TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/cascader/type.ts) | N
1313
middleContent | Slot / Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
1414
options | Array | [] | Typescript：`Array<CascaderOption>` | N
15+
overlayProps | Object | {} | Typescript：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/cascader/type.ts) | N
1516
placeholder | String / Slot / Function | '选择选项' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
1617
subTitles | Array | [] | Typescript：`Array<string>` | N
1718
theme | String | step | options: step/tab | N

‎packages/products/tdesign-mobile-vue/src/cascader/cascader.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ header | Slot / Function | - | 头部。TS 类型：`TNode`。[通用类型定
1212
keys | Object | - | 用来定义 value / label / children / disabled 在 `options` 中对应的字段别名。TS 类型：`CascaderKeysType` `type CascaderKeysType = TreeKeysType`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/cascader/type.ts) | N
1313
middleContent | Slot / Function | - | 中间内容。TS 类型：`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
1414
options | Array | [] | 可选项数据源。TS 类型：`Array<CascaderOption>` | N
15+
overlayProps | Object | {} | 遮罩层的属性，透传至 overlay。TS 类型：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/cascader/type.ts) | N
1516
placeholder | String / Slot / Function | '选择选项' | 未选中时的提示文案。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
1617
subTitles | Array | [] | 每级展示的次标题。TS 类型：`Array<string>` | N
1718
theme | String | step | 展示风格。可选项：step/tab | N

‎packages/products/tdesign-mobile-vue/src/cascader/props.ts‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export default {
1313
/** 关闭按钮 */
1414
closeBtn: {
1515
type: [Boolean, Function] as PropType<TdCascaderProps['closeBtn']>,
16-
default: true,
16+
default: true as TdCascaderProps['closeBtn'],
1717
},
1818
/** 头部 */
1919
header: {
@@ -32,10 +32,15 @@ export default {
3232
type: Array as PropType<TdCascaderProps['options']>,
3333
default: (): TdCascaderProps['options'] => [],
3434
},
35+
/** 遮罩层的属性，透传至 overlay */
36+
overlayProps: {
37+
type: Object as PropType<TdCascaderProps['overlayProps']>,
38+
default: () => ({}),
39+
},
3540
/** 未选中时的提示文案 */
3641
placeholder: {
3742
type: [String, Function] as PropType<TdCascaderProps['placeholder']>,
38-
default: '选择选项',
43+
default: '选择选项' as TdCascaderProps['placeholder'],
3944
},
4045
/** 每级展示的次标题 */
4146
subTitles: {
@@ -58,11 +63,11 @@ export default {
5863
/** 选项值 */
5964
value: {
6065
type: [String, Number] as PropType<TdCascaderProps['value']>,
61-
default: undefined,
66+
default: undefined as TdCascaderProps['value'],
6267
},
6368
modelValue: {
6469
type: [String, Number] as PropType<TdCascaderProps['value']>,
65-
default: undefined,
70+
default: undefined as TdCascaderProps['value'],
6671
},
6772
/** 选项值，非受控属性 */
6873
defaultValue: {

‎packages/products/tdesign-mobile-vue/src/cascader/type.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
55
* */
66

7+
import { OverlayProps } from '../overlay';
78
import { TNode, TreeOptionData, TreeKeysType } from '../common';
89

910
export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOptionData> {
@@ -34,6 +35,11 @@ export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOpt
3435
* @default []
3536
*/
3637
options?: Array<CascaderOption>;
38+
/**
39+
* 遮罩层的属性，透传至 overlay
40+
* @default {}
41+
*/
42+
overlayProps?: OverlayProps;
3743
/**
3844
* 未选中时的提示文案
3945
* @default '选择选项'

‎packages/scripts/api.json‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22673,6 +22673,47 @@
2267322673
"Array"
2267422674
]
2267522675
},
22676+
{
22677+
"id": 1759199384,
22678+
"platform_framework": [
22679+
"8",
22680+
"16",
22681+
"32"
22682+
],
22683+
"component": "Cascader",
22684+
"field_category": 1,
22685+
"field_name": "overlayProps",
22686+
"field_type": [
22687+
"8"
22688+
],
22689+
"field_default_value": "{}",
22690+
"field_enum": "",
22691+
"field_desc_zh": "遮罩层的属性，透传至 overlay",
22692+
"field_desc_en": null,
22693+
"field_required": 0,
22694+
"event_input": "",
22695+
"create_time": "2025-09-30 02:29:44",
22696+
"update_time": "2025-09-30 02:29:44",
22697+
"event_output": null,
22698+
"custom_field_type": "OverlayProps【import { OverlayProps } from '@Overlay'】",
22699+
"syntactic_sugar": null,
22700+
"readonly": 1,
22701+
"html_attribute": 0,
22702+
"trigger_elements": "",
22703+
"deprecated": 0,
22704+
"version": "",
22705+
"test_description": null,
22706+
"support_default_value": 0,
22707+
"field_category_text": "Props",
22708+
"platform_framework_text": [
22709+
"Vue(Mobile)",
22710+
"React(Mobile)",
22711+
"Angular(Mobile)"
22712+
],
22713+
"field_type_text": [
22714+
"Object"
22715+
]
22716+
},
2267622717
{
2267722718
"id": 1725941069,
2267822719
"platform_framework": [

0 commit comments

Comments
 (0)