index.md

//navigation-compose/com.chrynan.navigation.compose/ComposeScopedNavigator

ComposeScopedNavigator

[common]
@ExperimentalNavigationApi

interface ComposeScopedNavigator<Scope, Key> : ComposeNavigator<Key>

Types

Name	Summary
Companion	[common] object Companion

Functions

Name	Summary
changeScope	[common] abstract fun changeScope(to: Scope)

Properties

Name	Summary
currentKey	[common] abstract val currentKey: Key
currentScope	[common] abstract val currentScope: Scope
initialKey	[common] abstract val initialKey: Key
initialScope	[common] abstract val initialScope: Scope
isInitialized	[common] abstract val isInitialized: Boolean
keyChanges	[common] abstract val keyChanges: Flow<Key>
scopeChanges	[common] abstract val scopeChanges: Flow<Scope>

Inheritors

Name
BaseComposeNavigatorByContentViewModel
BaseComposeNavigatorByKeyViewModel

Extensions

Name

Summary

currentScopeAsState

[common] @ExperimentalNavigationApi @Composable fun <Scope, Key> ComposeScopedNavigator<Scope, Key>.currentScopeAsState(initialCurrentScope: Scope): State<Scope> @ExperimentalNavigationApi @Composable fun <Scope, Key> ComposeScopedNavigator<Scope, Key>.currentScopeAsState(): State<Scope> Obtains the changes to the ComposeScopedNavigator.currentScope value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes.