Skip to content

Latest commit

 

History

History
459 lines (230 loc) · 10 KB

ConfirmDialogOptions.md

File metadata and controls

459 lines (230 loc) · 10 KB

@serenity-is/corelib / ConfirmDialogOptions

Interface: ConfirmDialogOptions

Additional options for confirm dialog

Extends

Properties

autoDispose?

optional autoDispose: boolean

Auto dispose dialog on close, default is true

Inherited from

MessageDialogOptions.autoDispose

Defined in

src/base/dialogs.tsx:35


autoOpen?

optional autoOpen: boolean

True to auto open dialog

Inherited from

MessageDialogOptions.autoOpen

Defined in

src/base/dialogs.tsx:37


backdrop?

optional backdrop: boolean | "static"

Backdrop type, static to make it modal, e.g. can't be closed by clicking outside

Inherited from

MessageDialogOptions.backdrop

Defined in

src/base/dialogs.tsx:39


buttons?

optional buttons: DialogButton[]

List of buttons to show on the dialog

Inherited from

MessageDialogOptions.buttons

Defined in

src/base/dialogs.tsx:41


cancelButton?

optional cancelButton: boolean

True to also add a cancel button

Defined in

src/base/dialogs.tsx:980


centered?

optional centered: boolean

Vertically center modal

Inherited from

MessageDialogOptions.centered

Defined in

src/base/dialogs.tsx:43


closeButton?

optional closeButton: boolean

Show close button, default is true

Inherited from

MessageDialogOptions.closeButton

Defined in

src/base/dialogs.tsx:45


closeOnEscape?

optional closeOnEscape: boolean

Close dialog on escape key. Default is true for message dialogs.

Inherited from

MessageDialogOptions.closeOnEscape

Defined in

src/base/dialogs.tsx:47


dialogClass?

optional dialogClass: string

CSS class to use for all dialog types. Is added to the top ui-dialog, panel or modal element

Inherited from

MessageDialogOptions.dialogClass

Defined in

src/base/dialogs.tsx:49


element?

optional element: HTMLElement | ArrayLike<HTMLElement> | (element) => void

Dialog content/body element, or callback that will populate the content element

Inherited from

MessageDialogOptions.element

Defined in

src/base/dialogs.tsx:51


fade?

optional fade: boolean

Enable / disable animation. Default is false for message dialogs, true for other dialogs

Inherited from

MessageDialogOptions.fade

Defined in

src/base/dialogs.tsx:53


fullScreen?

optional fullScreen: boolean | "sm-down" | "md-down" | "lg-down" | "xl-down" | "xxl-down"

Sets one of modal-fullscreen{-...-down} classes. Only used for bootstrap modals

Inherited from

MessageDialogOptions.fullScreen

Defined in

src/base/dialogs.tsx:55


htmlEncode?

optional htmlEncode: boolean

HTML encode the message, default is true

Inherited from

MessageDialogOptions.htmlEncode

Defined in

src/base/dialogs.tsx:895


modal?

optional modal: boolean

Modal option for jQuery UI dialog compatibility only. Not to be confused with Bootstrap modal.

Inherited from

MessageDialogOptions.modal

Defined in

src/base/dialogs.tsx:57


onCancel()?

optional onCancel: () => void

Event handler for cancel button click

Returns

void

Defined in

src/base/dialogs.tsx:982


onClose()?

optional onClose: (result, e?) => void

Event handler that is called when dialog is closed

Parameters

result

string

e?

Event

Returns

void

Inherited from

MessageDialogOptions.onClose

Defined in

src/base/dialogs.tsx:61


onNo()?

optional onNo: () => void

Event handler for no button click

Returns

void

Defined in

src/base/dialogs.tsx:984


onOpen()?

optional onOpen: (e?) => void

Event handler that is called when dialog is opened

Parameters

e?

Event

Returns

void

Inherited from

MessageDialogOptions.onOpen

Defined in

src/base/dialogs.tsx:59


preferBSModal?

optional preferBSModal: boolean

Prefer Bootstrap modals to jQuery UI dialogs when both are available

Inherited from

MessageDialogOptions.preferBSModal

Defined in

src/base/dialogs.tsx:63


preferPanel?

optional preferPanel: boolean

Prefer Panel even when Modal / jQuery UI is available

Inherited from

MessageDialogOptions.preferPanel

Defined in

src/base/dialogs.tsx:65


preWrap?

optional preWrap: boolean

Wrap the message in a <pre> element, so that line endings are preserved, default is true

Inherited from

MessageDialogOptions.preWrap

Defined in

src/base/dialogs.tsx:897


providerOptions()?

optional providerOptions: (type, opt) => any

Callback to get options specific to the dialog provider type

Parameters

type

DialogProviderType

opt

DialogOptions

Returns

any

Inherited from

MessageDialogOptions.providerOptions

Defined in

src/base/dialogs.tsx:67


scrollable?

optional scrollable: boolean

Scrollable, sets content of the modal to scrollable, only for Bootstrap

Inherited from

MessageDialogOptions.scrollable

Defined in

src/base/dialogs.tsx:69


size?

optional size: "sm" | "md" | "lg" | "xl"

Size. Default is null for (500px) message dialogs, lg for normal dialogs

Inherited from

MessageDialogOptions.size

Defined in

src/base/dialogs.tsx:71


title?

optional title: string

Dialog title

Inherited from

MessageDialogOptions.title

Defined in

src/base/dialogs.tsx:73


width?

optional width: number

Only used for jQuery UI dialogs for backwards compatibility

Inherited from

MessageDialogOptions.width

Defined in

src/base/dialogs.tsx:75