Navigator

interface Navigator

A navigation component that allows navigation between destinations.

Use Hilt injection to get an instance of this interface.

Functions

abstract fun currentDestination(): StateFlow<DestinationId<*, *>?>

Current destination as flow.

abstract fun isInHierarchy(destination: DestinationId<*, *>): StateFlow<Boolean>

Checks whether the given destination is in the back stack.

open fun navigateTo(to: DestinationId<Unit, *>, navOptions: NavOptions? = null)

Requests navigation to the given destination which takes no input parameter.

abstract fun <A> navigateTo(to: DestinationId<A, *>, args: A, navOptions: NavOptions? = null)

open fun <A> navigateTo(to: DestinationId<A, *>, args: A, builder: NavOptionsBuilder.() -> Unit)

Requests navigation to the given destination. An required parameter must be passed.

abstract fun navigateUp()

Navigates up to previous destination, or finishes the Activity.

abstract fun <R> navigateUpWithResult(from: DestinationId<*, R>, result: R)

Navigates up to previous destination passing the given result, or finishes the Activity.

abstract fun open(link: Uri)

Opens the given link in a browser.

Creates a flow that will emit the results of the navigation from the given destination.