DialogJson

Interface

The dialog json. Dialog is the synonym of the Window in UI.

Inheritance: DialogJsonAbstractContainerJson

Properties

PropertyTypeNotes
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

{ LARGE: DialogSizeMode; MEDIUM: DialogSizeMode; SMALL: DialogSizeMode }

The dialog size mode.

alwaysShowConfirmation

Interface Property
alwaysShowConfirmation: boolean

Valid when confirmBeforeClose is true. Whether the confirmation window displays again or not after it is checked.

border

optional
Interface Property
border: BorderStyle

The dialog border style.

borderRadius

optional
Interface Property
borderRadius: FourSidesUnit

The dialog border radius.

boxShadow

optional
Interface Property
boxShadow: BoxShadowStyle

The dialog box shadow.

closeWhenClickOverlay

Interface Property
closeWhenClickOverlay: boolean

Close dialog when clicking outside.

confirmBeforeClose

Interface Property
confirmBeforeClose: 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.

dialogBackground

optional
Interface Property
dialogBackground: BackgroundStyle

The dialog background.

effect

optional
Interface Property
effect: AnimationSetting

The animation for the entire dialog.

icon

Interface Property
icon: string | IconResult

The dialog icon.

id

Interface Property
id: string

The dialog id.

index

optional
Interface Property
index: number

To distinct the display order for dialog list. Each mode, Fixed and Anchored, has its own order list starting with 0.

interactionStyles

Interface Property
interactionStyles: any

Details for interaction: checkbox text and font-size, button text and font-size.

interactionType

Interface Property
interactionType: DialogInteractionType

Interaction is valid when the dialog mode is FIXED.

isSplash

Interface Property
isSplash: 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.

The splash dialog id is not put in the URL, and can't be set as page dialog or link dialog.

label

Interface Property
label: string

The dialog label.

mode

Interface Property
mode: DialogMode

The dialog mode.

oneByOneEffect

optional
Interface Property
oneByOneEffect: AnimationSetting

The animation for all widgets inside the dialog.

overlayColor

optional
Interface Property
overlayColor: any

The dialog overlay color.

preventDisplayAgain

Interface Property
preventDisplayAgain: 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

sizeMode

Interface Property
sizeMode: { LARGE: DialogSizeMode; MEDIUM: DialogSizeMode; SMALL: DialogSizeMode }

The dialog size mode.

Type declaration

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.