Skip to content

Commit 9da8ead

Browse files
authored
docs(ActionSheet): regenerate api docs (#3601)
1 parent 565cc0d commit 9da8ead

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

src/action-sheet/README.en-US.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,23 @@ align | String | center | `0.29.0`。options: center/left | N
1212
cancel-text | String | - | \- | N
1313
count | Number | 8 | \- | N
1414
description | String | - | `0.29.0` | N
15-
items | Array | - | required。Typescript:`Array<string \| ActionSheetItem>` `interface ActionSheetItem {label: string; color?: string; disabled?: boolean;icon?: string;suffixIcon?: string; }`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts) | Y
15+
items | Array | - | required。Typescript:`Array<string \| ActionSheetItem>` `interface ActionSheetItem { label: string; color?: string; disabled?: boolean; icon?: string; suffixIcon?: string }`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts) | Y
1616
popup-props | Object | {} | Typescript:`PopupProps`[Popup API Documents](./popup?tab=api)[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts) | N
1717
show-cancel | Boolean | true | \- | N
1818
show-overlay | Boolean | true | \- | N
1919
theme | String | list | options: list/grid | N
2020
using-custom-navbar | Boolean | false | \- | N
21-
visible | Boolean | false | Show or hide | N
21+
visible | Boolean | false | \- | N
2222
default-visible | Boolean | undefined | uncontrolled property | N
2323

2424
### ActionSheet Events
2525

2626
name | params | description
2727
-- | -- | --
2828
cancel | \- | \-
29-
close | `(trigger: TriggerSource)` | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts)。<br/>`type TriggerSource = 'overlay' \| 'command' \| 'select' `<br/>
29+
close | `(trigger: ActionSheetTriggerSource)` | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts)。<br/>`type ActionSheetTriggerSource = 'overlay' \| 'command' \| 'select' `<br/>
3030
selected | `(selected: ActionSheetItem \| string, index: number)` | \-
31+
3132
### ActionSheet External Classes
3233

3334
className | Description
@@ -49,4 +50,4 @@ Name | Default Value | Description
4950
--td-action-sheet-description-color | @font-gray-3 | -
5051
--td-action-sheet-list-item-disabled-color | @font-gray-4 | -
5152
--td-action-sheet-list-item-height | 112rpx | -
52-
--td-action-sheet-text-align | center | -
53+
--td-action-sheet-text-align | center | -

src/action-sheet/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ align | String | center | `0.29.0`。水平对齐方式。可选项:center/lef
100100
cancel-text | String | - | 设置取消按钮的文本 | N
101101
count | Number | 8 | 设置每页展示菜单的数量,仅当 type=grid 时有效 | N
102102
description | String | - | `0.29.0`。动作面板描述文字 | N
103-
items | Array | - | 必需。菜单项。TS 类型:`Array<string \| ActionSheetItem>` `interface ActionSheetItem {label: string; color?: string; disabled?: boolean;icon?: string;suffixIcon?: string; }`[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts) | Y
104-
popup-props | Object | {} | popupProps透传。TS 类型:`PopupProps`[Popup API Documents](./popup?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts) | N
103+
items | Array | - | 必需。菜单项。TS 类型:`Array<string \| ActionSheetItem>` `interface ActionSheetItem { label: string; color?: string; disabled?: boolean; icon?: string; suffixIcon?: string }`[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts) | Y
104+
popup-props | Object | {} | 透传 Popup 组件全部属性。TS 类型:`PopupProps`[Popup API Documents](./popup?tab=api)[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts) | N
105105
show-cancel | Boolean | true | 是否显示取消按钮 | N
106106
show-overlay | Boolean | true | 是否显示遮罩层 | N
107107
theme | String | list | 展示类型,列表和表格形式展示。可选项:list/grid | N
@@ -114,8 +114,9 @@ default-visible | Boolean | undefined | 显示与隐藏。非受控属性 | N
114114
名称 | 参数 | 描述
115115
-- | -- | --
116116
cancel | \- | 点击取消按钮时触发
117-
close | `(trigger: TriggerSource)` | 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts)。<br/>`type TriggerSource = 'overlay' \| 'command' \| 'select' `<br/>
117+
close | `(trigger: ActionSheetTriggerSource)` | 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/action-sheet/type.ts)。<br/>`type ActionSheetTriggerSource = 'overlay' \| 'command' \| 'select' `<br/>
118118
selected | `(selected: ActionSheetItem \| string, index: number)` | 选择菜单项时触发
119+
119120
### ActionSheet External Classes
120121

121122
类名 | 描述

src/action-sheet/props.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const props: TdActionSheetProps = {
3131
type: Array,
3232
required: true,
3333
},
34-
/** popupProps透传 */
34+
/** 透传 Popup 组件全部属性 */
3535
popupProps: {
3636
type: Object,
3737
value: {},
@@ -60,13 +60,11 @@ const props: TdActionSheetProps = {
6060
visible: {
6161
type: Boolean,
6262
value: null,
63-
required: true,
6463
},
6564
/** 显示与隐藏,非受控属性 */
6665
defaultVisible: {
6766
type: Boolean,
6867
value: false,
69-
required: true,
7068
},
7169
};
7270

src/action-sheet/type.ts

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export interface TdActionSheetProps {
4848
required?: boolean;
4949
};
5050
/**
51-
* popupProps透传
51+
* 透传 Popup 组件全部属性
5252
* @default {}
5353
*/
5454
popupProps?: {
@@ -91,19 +91,17 @@ export interface TdActionSheetProps {
9191
* 显示与隐藏
9292
* @default false
9393
*/
94-
visible: {
94+
visible?: {
9595
type: BooleanConstructor;
9696
value?: boolean;
97-
required?: boolean;
9897
};
9998
/**
10099
* 显示与隐藏,非受控属性
101100
* @default false
102101
*/
103-
defaultVisible: {
102+
defaultVisible?: {
104103
type: BooleanConstructor;
105104
value?: boolean;
106-
required?: boolean;
107105
};
108106
}
109107

0 commit comments

Comments
 (0)