Skip to content

navigate() function

Navigate to a page.

Parameters:

Name Type Description Default

state

State

The current user state as received in any callback.

required

to

Optional[str]

The name of the page to navigate to. This can be a page identifier (as created by Gui.add_page() with no leading '/') or a URL.
If omitted, the application navigates to the root page.

''

params

Optional[Dict[str, str]]

A dictionary of query parameters.

None

tab

Optional[str]

When navigating to a page that is not a known page, the page is opened in a tab identified by tab (as in window.open).
The default value creates a new tab for the page (which is equivalent to setting tab to "_blank").

None

force

Optional[bool]

When navigating to a known page, the content is refreshed even it the page is already shown.

False