class NavEntry<T : Any>(key: T, val contentKey: Any = defaultContentKey(key), val metadata: Map<String, Any> = emptyMap(), content: @Composable (T) -> Unit)

Entry maintains and stores the key and the content represented by that key. Entries should be created as part of a reference/androidx/navigation/NavDisplay.

NavEntryDecorator

@Immutable

open class NavEntryDecorator<T : Any>(onPop: (key: Any) -> Unit = {}, decorate: @Composable (entry: NavEntry<T>) -> Unit)

Decorate the NavEntrys that are integrated with a rememberDecoratedNavEntries.

NavKey

interface NavKey

Marker interface for keys.

NavMetadataKey

interface NavMetadataKey<T : Any>

The base Key to be associated with value of type T.

SaveableStateHolderNavEntryDecorator

class SaveableStateHolderNavEntryDecorator<T : Any>(saveableStateHolder: SaveableStateHolder) : NavEntryDecorator<T>

Wraps the content of a NavEntry with a SaveableStateHolder.SaveableStateProvider to ensure that calls to rememberSaveable within the content work properly and that state can be saved. Also provides the content of a NavEntry with a SavedStateRegistryOwner which can be accessed in the content with LocalSavedStateRegistryOwner.

Functions

contains

operator fun <T : Any> Map<String, Any>.contains(key: NavMetadataKey<T>): Boolean

Checks if the metadata contains a given key.

entryProvider

inline fun <T : Any> entryProvider(noinline fallback: (unknownScreen: T) -> NavEntry<T> = { throw IllegalStateException("Unknown screen $it") }, builder: EntryProviderScope<T>.() -> Unit): (T) -> NavEntry<T>

Provides a EntryProviderScope to build an entryProvider that provides NavEntries.

get

operator fun <T : Any> Map<String, Any>.get(key: NavMetadataKey<T>): T?

Returns the metadata value for a given NavMetadataKey.

metadata

inline fun metadata(builder: MetadataScope.() -> Unit): Map<String, Any>

Provides a MetadataScope to build a Map of metadata.

rememberDecoratedNavEntries

@Composable

fun <T : Any> rememberDecoratedNavEntries(entries: List<NavEntry<T>>, entryDecorators: List<@JvmSuppressWildcards NavEntryDecorator<T>> = listOf()): List<NavEntry<T>>

Decorates the entries with the entryDecorators and returns the list of decorated NavEntries.

@Composable

fun <T : Any> rememberDecoratedNavEntries(backStack: List<T>, entryDecorators: List<@JvmSuppressWildcards NavEntryDecorator<T>> = listOf(), entryProvider: (key: T) -> NavEntry<T>): List<NavEntry<T>>

Remembers and returns a list of NavEntry decorated with the list of entryDecorators

rememberNavBackStack

@Composable

fun rememberNavBackStack(vararg elements: NavKey): NavBackStack<NavKey>

Provides a NavBackStack that is automatically remembered in the Compose hierarchy across process death and configuration changes.

@Composable

fun rememberNavBackStack(configuration: SavedStateConfiguration, vararg elements: NavKey): NavBackStack<NavKey>

Provides a NavBackStack that is automatically remembered in the Compose hierarchy across process death and configuration changes.

rememberSaveableStateHolderNavEntryDecorator

@Composable

fun <T : Any> rememberSaveableStateHolderNavEntryDecorator(saveableStateHolder: SaveableStateHolder = rememberSaveableStateHolder()): SaveableStateHolderNavEntryDecorator<T>

Returns a SaveableStateHolderNavEntryDecorator that is remembered across recompositions.