70 lines
2.8 KiB
Markdown
70 lines
2.8 KiB
Markdown
:: BASE_DOC ::
|
||
|
||
## API
|
||
|
||
### Dialog Props
|
||
|
||
name | type | default | description | required
|
||
-- | -- | -- | -- | --
|
||
custom-style | Object | - | CSS(Cascading Style Sheets) | N
|
||
actions | Array | - | Typescript：`Array<ButtonProps>`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/dialog/type.ts) | N
|
||
button-layout | String | horizontal | options: horizontal/vertical | N
|
||
cancel-btn | String / Object | - | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/dialog/type.ts) | N
|
||
close-btn | Boolean / Object | false | Typescript：`boolean \| ButtonProps \| null`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/dialog/type.ts) | N
|
||
close-on-overlay-click | Boolean | false | \- | N
|
||
confirm-btn | String / Object | - | \- | N
|
||
content | String | - | \- | N
|
||
overlay-props | Object | {} | Typescript：`OverlayProps`，[Overlay API Documents](./overlay?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/dialog/type.ts) | N
|
||
prevent-scroll-through | Boolean | true | \- | N
|
||
show-overlay | Boolean | true | \- | N
|
||
title | String | - | \- | N
|
||
using-custom-navbar | Boolean | false | \- | N
|
||
visible | Boolean | - | \- | N
|
||
z-index | Number | 11500 | \- | N
|
||
|
||
### Dialog Events
|
||
|
||
name | params | description
|
||
-- | -- | --
|
||
action | `(context: { index: number })` | \-
|
||
cancel | `(context: { e: MouseEvent })` | \-
|
||
close | `(context: { trigger: DialogEventSource })` | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/dialog/type.ts)。<br/>`type DialogEventSource = 'cancel' \| 'overlay' \| 'close-btn'`<br/>
|
||
confirm | `(context: { e: MouseEvent })` | \-
|
||
overlay-click | `(context: { e: MouseEvent })` | \-
|
||
|
||
### Dialog Slots
|
||
|
||
name | Description
|
||
-- | --
|
||
actions | \-
|
||
cancel-btn | \-
|
||
confirm-btn | \-
|
||
content | \-
|
||
middle | \-
|
||
title | \-
|
||
top | \-
|
||
|
||
### Dialog External Classes
|
||
|
||
className | Description
|
||
-- | --
|
||
t-class | \-
|
||
t-class-action | \-
|
||
t-class-cancel | \-
|
||
t-class-confirm | \-
|
||
t-class-content | \-
|
||
|
||
### CSS Variables
|
||
|
||
The component provides the following CSS variables, which can be used to customize styles.
|
||
Name | Default Value | Description
|
||
-- | -- | --
|
||
--td-dialog-body-max-height | 912rpx | -
|
||
--td-dialog-border-radius | @radius-extraLarge | -
|
||
--td-dialog-close-color | @text-color-placeholder | -
|
||
--td-dialog-content-color | @text-color-secondary | -
|
||
--td-dialog-content-font | @font-body-large | -
|
||
--td-dialog-title-color | @text-color-primary | -
|
||
--td-dialog-title-font | @font-title-large | -
|
||
--td-dialog-width | 622rpx | -
|