core/net.zagart.navigation/Destination/Args

Args

@Serializable

data class Args(val backstackIndex: Int = 0, val transition: Transition? = null, val key: String = "", val showTopBar: Boolean = false, val showNavigationBar: Boolean = false, val skipBackstack: Boolean = false, var result: Destination.Result? = null)

The minimum set of data required for navigation system to handle Destination.

Constructors

Args

constructor(backstackIndex: Int = 0, transition: Transition? = null, key: String = "", showTopBar: Boolean = false, showNavigationBar: Boolean = false, skipBackstack: Boolean = false, result: Destination.Result? = null)

Properties

backstackIndex

val backstackIndex: Int

Defines backstack index your destination belongs to.

key

val key: String

Used by SaveableStateHolder to restore screen state. You may want to specify it if scroll state for Composable is not saved during screen transition animation.

result

var result: Destination.Result?

Result passed from previous screen via BackDestination.

showNavigationBar

val showNavigationBar: Boolean

Defines whether it is responsibility of destination to show navigation bar. Navigation system uses this property to understand whether NavigationContainer should show navigation bar, specified in parameters (helps to avoid overlapping with destination-specific navigation bar).

showTopBar

val showTopBar: Boolean

Defines whether it is responsibility of destination to show top bar. Navigation system uses this property to understand whether NavigationContainer should show top bar, specified in parameters (helps to avoid overlapping with destination-specific top bar).

skipBackstack

val skipBackstack: Boolean

When true, destination won't be saved in backstack and will be removed immediately after user leaves it. This is useful for screens, which shouldn't be returned to (for example, login screen).

transition

val transition: Transition?

Defines destination-specific transition animation; use NavigationConfiguration to specify default screen transitions.