closeModal

Closes the currently opened modal.

Signature

Copy
1
(closeData?: Serializable) => void

Parameters

NameTypeDescription
closeDataSerializableOptional. Data to pass to the modal's opener. This data is returned by openModal once the modal is closed. It must be Serializable data, which means it can be cloned using the structured clone algorithm. For example, you cannot pass function callbacks in this parameter.

Returns

void

Examples

To set up a dashboard client, refer to the setup guide.

Close a modal

Copy
1
client.dashboard.closeModal({ message: 'The modal is closed!' });
Was this helpful?
Yes
No