Skip to content

Commit 81e42e6

Browse files
authored
docs(Cascader): update api docs for mini (#765)
1 parent 0597ef3 commit 81e42e6

File tree

6 files changed

+14
-47
lines changed

6 files changed

+14
-47
lines changed

db/TDesign.db

0 Bytes
Binary file not shown.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ style | Object | - | CSS(Cascading Style Sheets) | N
1010
custom-style | Object | - | CSS(Cascading Style Sheets),used to set style on virtual component | N
1111
check-strictly | Boolean | false | \- | N
1212
close-btn | Boolean | true | \- | N
13-
keys | Object | - | Typescript`KeysType`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
14-
options | Array | [] | Typescript`Array<CascaderOption>` | N
13+
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
14+
options | Array | [] | Typescript: `Array<CascaderOption>` | N
1515
placeholder | String | 选择选项 | \- | N
16-
sub-titles | Array | [] | Typescript`Array<string>` | N
16+
sub-titles | Array | [] | Typescript: `Array<string>` | N
1717
theme | String | step | options: step/tab | N
1818
title | String | - | \- | N
1919
value | String / Number | null | \- | N

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ style | Object | - | 样式 | N
1010
custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N
1111
check-strictly | Boolean | false | 父子节点选中状态不再关联,可各自选中或取消 | N
1212
close-btn | Boolean | true | 关闭按钮 | N
13-
keys | Object | - | 用来定义 value / label 在 `options` 中对应的字段别名。TS 类型:`KeysType`[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
13+
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
1414
options | Array | [] | 可选项数据源。TS 类型:`Array<CascaderOption>` | N
1515
placeholder | String | 选择选项 | 未选中时的提示文案 | N
1616
sub-titles | Array | [] | 每级展示的次标题。TS 类型:`Array<string>` | N

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const props: TdCascaderProps = {
1616
type: Boolean,
1717
value: true,
1818
},
19-
/** 用来定义 value / label 在 `options` 中对应的字段别名 */
19+
/** 用来定义 value / label / children / disabled 在 `options` 中对应的字段别名 */
2020
keys: {
2121
type: Object,
2222
},

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

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

7-
import { TreeOptionData, KeysType } from '../common/common';
7+
import { TreeOptionData, TreeKeysType } from '../common/common';
88

99
export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOptionData> {
1010
/**
@@ -24,11 +24,11 @@ export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOpt
2424
value?: boolean;
2525
};
2626
/**
27-
* 用来定义 value / label 在 `options` 中对应的字段别名
27+
* 用来定义 value / label / children / disabled 在 `options` 中对应的字段别名
2828
*/
2929
keys?: {
3030
type: ObjectConstructor;
31-
value?: KeysType;
31+
value?: CascaderKeysType;
3232
};
3333
/**
3434
* 可选项数据源
@@ -94,3 +94,5 @@ export interface TdCascaderProps<CascaderOption extends TreeOptionData = TreeOpt
9494
value?: boolean;
9595
};
9696
}
97+
98+
export type CascaderKeysType = TreeKeysType;

packages/scripts/api.json

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -21405,48 +21405,12 @@
2140521405
"Object"
2140621406
]
2140721407
},
21408-
{
21409-
"id": 3347,
21410-
"platform_framework": [
21411-
"64"
21412-
],
21413-
"component": "Cascader",
21414-
"field_category": 1,
21415-
"field_name": "keys",
21416-
"field_type": [
21417-
"8"
21418-
],
21419-
"field_default_value": "",
21420-
"field_enum": "",
21421-
"field_desc_zh": "用来定义 value / label 在 `options` 中对应的字段别名",
21422-
"field_desc_en": null,
21423-
"field_required": 0,
21424-
"event_input": "",
21425-
"create_time": "2023-02-28 10:15:01",
21426-
"update_time": "2023-02-28 10:15:01",
21427-
"event_output": null,
21428-
"custom_field_type": "KeysType",
21429-
"syntactic_sugar": null,
21430-
"readonly": 1,
21431-
"html_attribute": 0,
21432-
"trigger_elements": "",
21433-
"deprecated": 0,
21434-
"version": "",
21435-
"test_description": null,
21436-
"support_default_value": 0,
21437-
"field_category_text": "Props",
21438-
"platform_framework_text": [
21439-
"Miniprogram"
21440-
],
21441-
"field_type_text": [
21442-
"Object"
21443-
]
21444-
},
2144521408
{
2144621409
"id": 1723804837,
2144721410
"platform_framework": [
2144821411
"8",
21449-
"16"
21412+
"16",
21413+
"64"
2145021414
],
2145121415
"component": "Cascader",
2145221416
"field_category": 1,
@@ -21475,7 +21439,8 @@
2147521439
"field_category_text": "Props",
2147621440
"platform_framework_text": [
2147721441
"Vue(Mobile)",
21478-
"React(Mobile)"
21442+
"React(Mobile)",
21443+
"Miniprogram"
2147921444
],
2148021445
"field_type_text": [
2148121446
"Object"

0 commit comments

Comments
 (0)