Open Dialog

The Open Dialog action allows you to display a modal dialog containing a custom component. Dialogs are useful for showing confirmations, forms, alerts, or any other UI content without navigating away from the current screen.

Note: Only components can be used as dialog content via the viewData property.

Use Cases

  • Displaying a confirmation prompt.

  • Showing a form or additional details without navigating.

  • Collecting input or returning a result from the user.

Properties

Property
Description

viewData

(Required) The component to render inside the dialog.

barrierDismissible

Boolean that determines whether tapping outside the dialog should dismiss it.

barrierColor

The background color of the barrier (overlay behind the dialog).

waitForResult

Boolean that enables listening for a return value from the dialog.

onResult

Optional action flow to run when a result is returned from the dialog. Only applicable if waitForResult is true.

Default Behavior

  • Displays the specified component as a modal dialog.

  • If barrierDismissible is not set or is true, tapping outside will close the dialog.

  • If waitForResult is enabled, the result can be captured using the onResult handler.

How to Use

  1. Attach the action to a widget (e.g., button or icon).

  2. Select Open Dialog from the action list.

  3. Provide a valid viewData pointing to a component.

  4. Optionally configure the barrier color and dismissal behavior.

  5. Enable waitForResult and define onResult to capture dialog output if needed.

Last updated