Go To Page

The Navigate to Page action allows you to programmatically navigate to another page within your app. It includes advanced options such as removing screens from the navigation stack and listening for return values.

Use Cases

  • Navigating to a new screen on button click or event.

  • Waiting for a result (e.g., from a form page) before proceeding.

  • Replacing the current navigation history for one-time flows (e.g., after login).

Properties

Property
Description

pageData

(Required) The target page to navigate to.

waitForResult

Boolean indicating whether to wait for a result to be returned from the target page. Default: false.

shouldRemovePreviousScreensInStack

Boolean that clears previous pages in the navigation stack when navigating. Default: false.

routeNametoRemoveUntil

If provided, all routes until this route will be removed from the stack.

onResult

Optional action flow to handle the result returned from the target page (only works if waitForResult is true).

Default Behavior

  • Navigates to the specified pageData.

  • The navigation stack remains unchanged unless shouldRemovePreviousScreensInStack or routeNametoRemoveUntil is used.

  • No data is returned from the destination page unless waitForResult is enabled and onResult is defined.

How to Use

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

  2. Select Navigate to Page from the action list.

  3. Choose the target pageData.

  4. Configure optional navigation stack behavior and result handling if needed.

Last updated