index.md

//navigation-compose/com.chrynan.navigation.compose/ComposeNavigator

ComposeNavigator

[common]
@ExperimentalNavigationApi

interface ComposeNavigator<T> : Navigator

Types

Name	Summary
Companion	[common] object Companion

Properties

Name	Summary
currentKey	[common] abstract val currentKey: T
initialKey	[common] abstract val initialKey: T
isInitialized	[common] abstract val isInitialized: Boolean
keyChanges	[common] abstract val keyChanges: Flow<T>

Inheritors

Name
ComposeNavigatorByContent
ComposeNavigatorByKey
ComposeStackNavigator
ComposeScopedNavigator
BaseComposeNavigatorByContentViewModel
BaseComposeNavigatorByKeyViewModel

Extensions

Name

Summary

currentKeyAsState

[common] @ExperimentalNavigationApi @Composable fun <Key> ComposeNavigator<Key>.currentKeyAsState(initialCurrentKey: Key): State<Key> @ExperimentalNavigationApi @Composable fun <Key> ComposeNavigator<Key>.currentKeyAsState(): State<Key> Obtains the changes to the ComposeNavigator.currentKey value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes.