:: BASE_DOC ::
API
| name |
type |
default |
description |
required |
| custom-style |
Object |
- |
CSS(Cascading Style Sheets) |
N |
| close-btn |
Boolean |
- |
- |
N |
| close-on-overlay-click |
Boolean |
true |
- |
N |
| content |
String |
- |
- |
N |
| duration |
Number |
240 |
- |
N |
| overlay-props |
Object |
{} |
Typescript：OverlayProps，Overlay API Documents。see more ts definition |
N |
| placement |
String |
top |
options: top/left/right/bottom/center |
N |
| prevent-scroll-through |
Boolean |
true |
- |
N |
| show-overlay |
Boolean |
true |
- |
N |
| using-custom-navbar |
Boolean |
false |
- |
N |
| visible |
Boolean |
- |
v-model:visible is supported。Typescript：boolean |
N |
| default-visible |
Boolean |
- |
uncontrolled property。Typescript：boolean |
N |
| z-index |
Number |
11500 |
- |
N |
| name |
params |
description |
| visible-change |
(context: { visible: boolean, trigger: PopupSource }) |
see more ts definition。
type PopupSource = 'close-btn' | 'overlay'
|
| name |
Description |
| - |
- |
| close-btn |
- |
| content |
- |
| className |
Description |
| t-class |
- |
| t-class-content |
- |
CSS Variables
The component provides the following CSS variables, which can be used to customize styles.
| Name |
Default Value |
Description |
| --td-popup-bg-color |
@bg-color-container |
- |
| --td-popup-border-radius |
@radius-extraLarge |
- |
| --td-popup-close-btn-color |
@text-color-primary |
- |
| --td-popup-distance-top |
0 |
- |
| --td-popup-transition |
all 300ms ease |
- |
