DialogJson
Interface
The dialog json. Dialog is the synonym of the Window in UI.
Properties
| Property | Type | Notes |
|---|---|---|
boolean | Valid when confirmBeforeClose is true. Whether the confirmation window displays again or not after it is checked. | |
BorderStyle | The dialog border style. | |
FourSidesUnit | The dialog border radius. | |
BoxShadowStyle | The dialog box shadow. | |
boolean | Close dialog when clicking outside. | |
boolean | Two interactions. Confirmation: true. Users must check the confirmation box before closing the dialog. "Don't show this again" option: false. It is optional. If checked, the window will not display again. | |
BackgroundStyle | The dialog background. | |
AnimationSetting | The animation for the entire dialog. | |
string | IconResult | The dialog icon. | |
string | The dialog id. | |
number | To distinct the display order for dialog list. Each mode, Fixed and Anchored, has its own order list starting with 0. | |
any | Details for interaction: checkbox text and font-size, button text and font-size. | |
Interaction is valid when the dialog mode is FIXED. | ||
boolean | If a dialog is a splash, the dialog will open automatically when the app get loaded. Only one fixed dialog can be set as splash. | |
string | The dialog label. | |
The dialog mode. | ||
AnimationSetting | The animation for all widgets inside the dialog. | |
any | The dialog overlay color. | |
boolean | The other interaction. Valid when dialog's mode is FIXED. Users must check the checkbox box before closing the dialog. The window will never display again | |
{} | The dialog size mode. |
alwaysShowConfirmation
border optional
border: BorderStyleThe dialog border style.
borderRadius optional
borderRadius: FourSidesUnitThe dialog border radius.
boxShadow optional
boxShadow: BoxShadowStyleThe dialog box shadow.
closeWhenClickOverlay
closeWhenClickOverlay: booleanClose dialog when clicking outside.
confirmBeforeClose
confirmBeforeClose: booleanTwo interactions. Confirmation: true. Users must check the confirmation box before closing the dialog. "Don't show this again" option: false. It is optional. If checked, the window will not display again.
dialogBackground optional
dialogBackground: BackgroundStyleThe dialog background.
effect optional
effect: AnimationSettingThe animation for the entire dialog.
icon
icon: string | IconResultThe dialog icon.
id
id: stringThe dialog id.
index optional
index: numberTo distinct the display order for dialog list. Each mode, Fixed and Anchored, has its own order list starting with 0.
interactionStyles
interactionStyles: anyDetails for interaction: checkbox text and font-size, button text and font-size.
interactionType
interactionType: DialogInteractionTypeInteraction is valid when the dialog mode is FIXED.
isSplash
isSplash: booleanIf a dialog is a splash, the dialog will open automatically when the app get loaded. Only one fixed dialog can be set as splash.
The splash dialog id is not put in the URL, and can't be set as page dialog or link dialog.
label
label: stringThe dialog label.
mode
mode: DialogModeThe dialog mode.
oneByOneEffect optional
oneByOneEffect: AnimationSettingThe animation for all widgets inside the dialog.
overlayColor optional
overlayColor: anyThe dialog overlay color.
preventDisplayAgain
preventDisplayAgain: booleanThe other interaction. Valid when dialog's mode is FIXED. Users must check the checkbox box before closing the dialog. The window will never display again
sizeMode
sizeMode: {}The dialog size mode.
alwaysShowConfirmation: booleanValid when confirmBeforeClose is true. Whether the confirmation window displays again or not after it is checked.