The modal interface enables your plug-in to manage modal dialog windows.

modal.AlertLevel

Description

Enum:

  • SUCCESS

  • INFO

  • WARNING

  • DANGER

Clarity adds a standard icon, depending on the alert level. See https://v2.clarity.design/alerts.

Used by: modal.ConfirmationModalConfig

modal.ButtonStyle

Description

Enum:

  • SUCCESS

  • INFO

  • WARNING

  • DANGER

Clarity adds default CSS tags, depending on the action importance:
  • btn-success
  • btn-primary
  • btn-warning
  • btn-danger

For examples of Clarity button styling, see the Solid Buttons illustrations at https://v2.clarity.design/buttons/#examples.

Used by: modal.ModalButton

modal.ButtonType

Description

Enum:

  • PRIMARY

  • SECONDARY

Clarity styles PRIMARY buttons with greater emphasis. See https://v2.clarity.design/buttons.

Used by: modal.ModalButton

modal.close()

Signature

Closes the modal dialog box in the parent iframe.

Description

Optional data that will be passed to callback function specified by onClosed property at dialog open.

Parameter: data

Optional data that will be passed to callback function specified by onClosed property at dialog open.
Note: No data is passed to the callback function if the user clicks the dialog close box.

modal.ConfirmationModalConfig

Description

Specifies the properties of a confirmation modal dialog box.

Property

Type

Required?

Notes

content

string

yes

Confirmation message displayed in the dialog.

buttons

modal.ModalButton[]

yes

Buttons displayed in the dialog footer. (min 1, max 4)

title

string

no

Dialog main title. May not contain an icon. (default='')

AccessibilityTitle

string

no

Used when dialog title is not displayed, such as in a wizard dialog.

size

modal.ModalSize

no

Width of the dialog box. (Default width is chosen by Clarity. Height is fixed.)

closable

boolean

no

Whether the dialog displays a close button. (default=true)

onClosed

function(result:any): void

no

Function runs when user closes the dialog. If modal.close() is called, its parameter is in turn passed to the onClosed() function.

Function runs when user closes the dialog. If modal.close() is called, its parameter is in turn passed to the onClosed() function.

secondaryTitle

string

no

Optional subtitle for the dialog.

alertLevel

modal.AlertLevel

no

Causes Clarity to add an icon to the dialog.

Used by: modal.openConfirmationModal()

modal.DynamicModalConfig

Description

Specifies values for some properties of a modal dialog box.

Property

Type

Required?

Notes

title

string

no

Dialog title. May not contain an icon.

(If not present, no change to dialog title.)

accessibilityTitle

string

no

Used when dialog title is not displayed, such as in a wizard dialog.

height

number

no

Dialog height, specified in pixels. (If not present, no change to dialog height.)

Used by: modal.setOptions()

modal.getCustomData()

Signature

modal.getCustomData():any

Description

Returns the customData object provided when a modal dialog box was opened, or null if no customData object was provided.

modal.ModalButton

Description

Describes button properties.

Property

Type

Required?

Notes

label

string

yes

type

modal.ButtonType

no

style

modal.ButtonStyle

no

callback

function(): void

no

Used by: modal.ConfirmationModalConfig

modal.ModalConfig

Description

Specifies the properties of a modal dialog box.

Property

Type

Required?

Notes

url

string

yes

Location of HTML content for the dialog.

title

string

no

Dialog title. May not contain an icon. (default='')

accessibilityTitle

string

no

Used when dialog title is not displayed, such as in a wizard dialog.

size

(width:number, height:number)

no

Specify in pixels. Default is chosen by Clarity. See https://v2.clarity.design/modals.

closable

boolean

no

Whether the dialog displays a close button. (default=true)

onClosed

function(result:any): void

no

Function runs when the dialog closes. If modal.close() is called, its parameter is in turn passed to the onClosed() function.

Function runs when the dialog closes. If modal.close() is called, its parameter is in turn passed to the onClosed() function.

customData

any

no

Data the calling module passes to the dialog.

contextObjects

any[]

no

IDs of relevant objects the calling module passes to the dialog.

Used by: modal.open()

modal.ModalSize

Description

Width of a modal dialog box.

Property

Type

Required?

Notes

width

number

yes

Specified in pixels.

Used by: modal.ConfirmationModalConfig

modal.open()

Signature

modal.open(configObj:modal.ModalConfig):void

Description

Opens a modal dialog box specified by the configObj parameter.

Parameter: configObj

Specifies the properties of this modal dialog box.

modal.openConfirmationModal()

Signature

modal.openConfirmationModal(configObj:modal.ConfirmationModalConfig):void

Description

Opens a lightweight modal dialog box designed to present information and confirmation buttons.

Parameter: configObj

Specifies the properties of this modal dialog box.

modal.setOptions()

Signature

modal.setOptions(configObj:modal.DynamicModalConfig):void

Description

Called by the parent view to modify some properties for a modal dialog box in the parent iframe.

Parameter: configObj

Specifies values for some dialog box properties.