Interface: ConfirmModalModel
ModalApi.ConfirmModalModel
Description
Modal used to display a confirmation message to the user
Properties
Properties
acceptAction
Optional
acceptAction: () => Promise
<boolean
>
Type declaration
Specifies further action after the user accepts
Returns
Promise
<boolean
>
acceptIsDestructive
Optional
acceptIsDestructive: boolean
If true, the accept button will be styled to indicate a destructive action. If false, it will be styled as a primary button.
acceptText
Optional
acceptText: string
Text to display for the accept button. Defaults to "Accept".
cancelAction
Optional
cancelAction: () => boolean
Type declaration
Specifies further action after the user cancels
Returns
boolean
cancelText
Optional
cancelText: string
Text to display for the cancel button. Defaults to "Cancel".
closeOnAcceptActionFailure
Optional
closeOnAcceptActionFailure: boolean
If true, the modal will close when the accept function errors
Optional
disableAcceptButtonAfterClick: boolean
If true, the accept button will be disabled after it is clicked
focusEls
Specifies an element to focus on
Type declaration
Name |
Type |
Description |
accept?
|
HTMLElement
|
HTMLElement to focus on when the accept action is taken |
cancel?
|
HTMLElement
|
HTMLElement to focus on when the cancel action is taken |
error?
|
HTMLElement
|
HTMLElement to focus on when an error occurs when the accept action is taken |
message
Message describing something that the user should confirm they want to act on.
title
Text to display in the modal header.