@interopio/browser API Reference

Options for showing a dialog from the Workspaces Frame.

Properties (23)

Property Type Default Required Description
affirmativeButtonName⚓︎ string x x

Name for the affirmative response button.
blur⚓︎ boolean false x

If true, will blur the area around the dialog displayed by the Frame instance. This property is valid only in the advanced platform mode and only if the "mode" property of the "transparencyControl" object under the "windowManagement" top-level key in the system configuration of io.Connect Desktop is set to "Transparent". Available only in io.Connect Desktop.

io.Connect Desktop 10.0.3
cancelButtonName⚓︎ string x x

Name for the canceling button.
context⚓︎ unknown x x

Context data that can be used by a custom dialog.
defaultAction⚓︎ "affirmative" | "negative" | "cancel" x x

Determines which dialog button to be the default one. The action tied to the default button will be executed when the user presses ENTER when no button is active (i.e., when the buttons aren't on focus and none is selected).
inputMaxLength⚓︎ number x x

The amount of characters that can be entered in the input field of a SingleInputDialog.
inputPattern⚓︎ string x x

String pattern that serves as a regular expression for validating the input from the user in a SingleInputDialog. If such pattern is specified and the input doesn't match it, an error will be displayed and the input field will indicate visually that the user input is invalid.
inputPatternErrorMessage⚓︎ string x x

Error message to be displayed if the user input doesn't match the specified validation pattern for a SingleInputDialog.
inputPlaceholder⚓︎ string x x

Placeholder that will be displayed in the input field of a SingleInputDialog.
message⚓︎ string x

Message to the user that the dialog will contain.
messageTitle⚓︎ string x x

Title for the message that will be displayed in the dialog.
mode⚓︎ DialogMode x x

Mode for the dialog.
movable⚓︎ boolean true x

If true, the user will be able to move the dialog.
negativeButtonName⚓︎ string x x

Name for the negative response button.
showAffirmativeButton⚓︎ boolean false x

If true, the affirmative response button will be shown in the dialog. The default value is for custom dialogs, as predefined dialog types have different defaults.
showCancelButton⚓︎ boolean false x

If true, the canceling button will be shown in the dialog. The default value is for custom dialogs, as predefined dialog types have different defaults.
showNegativeButton⚓︎ boolean false x

If true, the negative response button will be shown in the dialog. The default value is for custom dialogs, predefined dialog types have different defaults.
showTimer⚓︎ boolean false x

If true, a countdown timer will be shown in the dialog, warning the user that the dialog will close automatically after the specified time. You must also specify a value for timerDuration, otherwise a timer won't be shown.
size⚓︎ Size x x

Size for the dialog to show.
timerDuration⚓︎ number x x

Interval in seconds after which the dialog will close automatically. If showTimer is set to true, a countdown timer will be displayed in the dialog, otherwise the dialog will close silently without a warning for the user. If the user doesn't interact with the dialog before the timer expires, the action property of the DialogResult object will be set to "expired".
title⚓︎ string x x

Title for the dialog that will be displayed in the dialog header.
transparent⚓︎ boolean false x

If true, the io.Connect Window containing the dialog will be transparent.
type⚓︎ DialogType | string x

Type of the dialog to show. Can be either a predefined io.Connect dialog type, or a custom one.