Skip to main content

Routes management

Every time UX Framework sets and updates routes and alternatives (or builds a new one in case a user goes off-route) an event is produced and dispatched. To get notified about the available routes changing, you can collect the Dash.controller.observeRoutes flow. The flow provides list of routes which includes primary (recommended as default) and alternative routes with a set of additional metadata.

class MainActivity : AppCompatActivity() {

override fun onCreate(savedInstanceState: Bundle?) {

lifecycleScope.launch {
repeatOnLifecycle(Lifecycle.State.STARTED) {
.collect { /* RouteChangeEvent */ event ->
val activeNavRoute = event.routes.firstOrNull()
// Do something with active NavigationRoute

Important to notice, that the route at index 0, if exists, is treated as the primary route for Active Guidance.

Was this page helpful?