Interface: ModalApi

ModalApi.ModalApi

Description

Contains APIs to allow the opening of a modal for the current list

Properties

• confirm
• openCustomModal
• openExternalModal

Properties

confirm

• confirm: (model: ConfirmModalModel, openModalHandler?: OpenModalHandler) => Promise<DialogCloseResult>

Type declaration

▸ (model, openModalHandler?): Promise<DialogCloseResult>

Description

Allows the developer to show a confirmation modal

Parameters

Name	Type	Description
model	ConfirmModalModel	Confirmation modal to open
openModalHandler?	OpenModalHandler	Optional callback function executed immediately after the modal opens

Returns

Promise<DialogCloseResult>

Promise resolution once the modal is closed

---

openCustomModal

• openCustomModal: (model: CustomModalModel, openModalHandler?: OpenModalHandler) => Promise<DialogCloseResult>

Type declaration

▸ (model, openModalHandler?): Promise<DialogCloseResult>

Description

Allows the developer to show a modal with custom content based on the model received

Parameters

Name	Type	Description
model	CustomModalModel	Custom modal to open
openModalHandler?	OpenModalHandler	Optional callback function executed immediately after the modal opens

Returns

Promise<DialogCloseResult>

Promise resolution once the modal is closed

---

openExternalModal

• openExternalModal: (model: ExternalModalModel, openModalHandler?: OpenModalHandler) => Promise<DialogCloseResult>

Type declaration

▸ (model, openModalHandler?): Promise<DialogCloseResult>

Description

Allows the developer to show a modal which opens an iframe to a provided url

Parameters

Name	Type	Description
model	ExternalModalModel	External modal to open
openModalHandler?	OpenModalHandler	Optional callback function executed immediately after the modal opens

Returns

Promise<DialogCloseResult>

Promise resolution once the modal is closed