Skip to main content

Settings for displaying a dialog.

Properties (7)

Property Type Default Required Description
movable⚓︎ boolean true x

If true, the user will be able to move the dialog window. Available only in io.Connect Desktop.

size⚓︎ { width: number; height: number; } x x

Size for the dialog window.

target⚓︎ ModalsContainerType | string x x

Specifies the container in which the dialog will be displayed. This can be the current window container (e.g., the current Workspace), the entire io.Connect platform, or a specific window. To target a specific window, provide the Interop instance ID as a string. Defaults to "Global" in io.Connect Desktop. Defaults to "WindowContainer" in io.Connect Browser.

templateName⚓︎ string x

Type of the dialog to show. Can be either a predefined io.Connect dialog type or a custom one. The following predefined io.Connect dialog templates are available: "singleTextInputDialog", "singleCheckboxDialog", and "noInputsConfirmationDialog". For more details on the different predefined io.Connect dialogs, see the Capabilities > Modals section in the main documentation.

timer⚓︎ { duration: number; } x x

Countdown timer for the dialog. The timer is internal and not shown to the user. The dialog will close automatically after the specified time has elapsed.

transparent⚓︎ boolean false x

If true, the io.Connect Window containing the dialog will be transparent. Available only in io.Connect Desktop.

variables⚓︎ any x

Variables to pass for creating the dialog. Use this to specify heading, text, action buttons, and more for the predefined io.Connect dialogs, or to pass any other variables to your custom dialogs. For more details on the variables expected by the different predefined io.Connect dialogs, see the Capabilities > Modals section in the main documentation.