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
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 istrue
, tapping outside will close the dialog.If
waitForResult
is enabled, the result can be captured using theonResult
handler.
How to Use
Attach the action to a widget (e.g., button or icon).
Select Open Dialog from the action list.
Provide a valid
viewData
pointing to a component.Optionally configure the barrier color and dismissal behavior.
Enable
waitForResult
and defineonResult
to capture dialog output if needed.
Last updated