Router utils

The router object contains a few utils that can be used to programmatically navigate through the application.

Most of the navigation functions accept an options argument whose properties are documented in the router options page.

When a url argument is accepted, its type is the same as the url property of the options argument.

get, post, put, patch, delete

This function initiates a programmatic navigation to the given URL using the corresponding method.

When performing non-GET requests, by default, the preserveState option will be set to true.

router.get(url, options)
router.post(url, options)
router.put(url, options)
router.patch(url, options)
router.delete(url, options)

reload

This function initiates a programmatic navigation to the current URL. By default, the navigation will preserve the scroll position and the component's state.

router.reload(options)

local

This function initiates a local-only navigation. This navigation will not reach the server — it will only re-render the specified (or current) component with the specified properties.

router.local(options)

Its options argument is different from the other navigation functions: only the replace, preserveScroll and preserveState options are available. Additionally, a component and a properties options are also available.

interface ComponentNavigationOptions {
	/** Name of the component to use. */
	component?: string
	/** Properties to apply to the component. */
	properties?: Properties
}

Global properties

Note that, because of roundtrip-less nature, global properties will not be updated when using this method.

external

This function initiates an external, hard navigation. This is an equivalent of using document.location.href.

If provided, the data object will be converted to query parameters.

router.external(url, data)

navigate

This function initiates a programmatic navigation without any specific default.

router.navigate(options)

preload

This function preloads the given URL. Note that you may only preload GET hybrid requests.

router.preload(url, options)

abort

This function aborts the current request. The abort hook will be triggered.

current

This function returns the current route name, if defined.

matches

This function returns true if the given route name matches the current route name. Optionally, you may pass parameters to match more specific routes.

router.matches('tenant.*')
router.matches('profile', { user: currentUserId })

dialog.close

This function closes the current dialog. It takes the same options as the other router functions, as well as a local option that indicates whether a round-trip to the server will be made to update the base view's properties.

router.dialog.close()

history.get

This function fetches the given key from the history state. The state is specific to the current history entry.

router.history.get(key)

history.remember

This function sets the given key and value in the history state. The state is specific to the current history entry.

router.history.remember(key, value)