diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..533f252 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,8 @@ +/ + +## All modules: + +| Name | +|---| +| [navigation-compose](navigation-compose/index.md) | | +| [navigation-core](navigation-core/index.md) | | diff --git a/docs/navigation-compose/index.md b/docs/navigation-compose/index.md new file mode 100644 index 0000000..147627e --- /dev/null +++ b/docs/navigation-compose/index.md @@ -0,0 +1,9 @@ +//[navigation-compose](index.md) + +# navigation-compose + +## Packages + +| Name | +|---| +| [com.chrynan.navigation.compose](navigation-compose/com.chrynan.navigation.compose/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/-base-compose-navigator-by-content-view-model.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/-base-compose-navigator-by-content-view-model.md new file mode 100644 index 0000000..c60984b --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/-base-compose-navigator-by-content-view-model.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByContentViewModel](index.md)/[BaseComposeNavigatorByContentViewModel](-base-compose-navigator-by-content-view-model.md) + +# BaseComposeNavigatorByContentViewModel + +[common]\ +fun [BaseComposeNavigatorByContentViewModel](-base-compose-navigator-by-content-view-model.md)() diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/index.md new file mode 100644 index 0000000..e53a60a --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/index.md @@ -0,0 +1,35 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByContentViewModel](index.md) + +# BaseComposeNavigatorByContentViewModel + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +abstract class [BaseComposeNavigatorByContentViewModel](index.md)<[Scope](index.md), [Key](index.md)> : ViewModel, [ComposeNavigator](../-compose-navigator/index.md)<[Key](index.md)> , [ComposeNavigatorByContent](../-compose-navigator-by-content/index.md)<[Key](index.md)> , [ComposeStackNavigatorByContent](../-compose-stack-navigator-by-content/index.md)<[Key](index.md)> , [ComposeScopedNavigator](../-compose-scoped-navigator/index.md)<[Scope](index.md), [Key](index.md)> + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](../-compose-stack-navigator/can-go-back.md) | [common]
abstract fun [canGoBack](../-compose-stack-navigator/can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [changeScope](../-compose-scoped-navigator/change-scope.md) | [common]
abstract fun [changeScope](../-compose-scoped-navigator/change-scope.md)(to: [Scope](index.md)) | +| [goBack](../-compose-stack-navigator/go-back.md) | [common]
abstract fun [goBack](../-compose-stack-navigator/go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](../-compose-navigator-by-content/go-to.md) | [common]
@Composable
abstract fun [goTo](../-compose-navigator-by-content/go-to.md)(key: [Key](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md), content: @Composable[ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md)<[Key](index.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [Key](index.md) | +| [currentScope](../-compose-scoped-navigator/current-scope.md) | [common]
abstract val [currentScope](../-compose-scoped-navigator/current-scope.md): [Scope](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [Key](index.md) | +| [initialScope](../-compose-scoped-navigator/initial-scope.md) | [common]
abstract val [initialScope](../-compose-scoped-navigator/initial-scope.md): [Scope](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[Key](index.md)> | +| [scopeChanges](../-compose-scoped-navigator/scope-changes.md) | [common]
abstract val [scopeChanges](../-compose-scoped-navigator/scope-changes.md): Flow<[Scope](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeNavigatorByContentViewModel](../-compose-navigator-by-content-view-model/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/-base-compose-navigator-by-key-view-model.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/-base-compose-navigator-by-key-view-model.md new file mode 100644 index 0000000..0f7e60b --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/-base-compose-navigator-by-key-view-model.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[BaseComposeNavigatorByKeyViewModel](-base-compose-navigator-by-key-view-model.md) + +# BaseComposeNavigatorByKeyViewModel + +[common]\ +fun <[Scope](index.md), [Key](index.md)> [BaseComposeNavigatorByKeyViewModel](-base-compose-navigator-by-key-view-model.md)(initialScope: [Scope](index.md), initialKeys: ([Scope](index.md)) -> [Key](index.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/can-go-back.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/can-go-back.md new file mode 100644 index 0000000..ffe9470 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/can-go-back.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[canGoBack](can-go-back.md) + +# canGoBack + +[common]\ +open override fun [canGoBack](can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/change-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/change-scope.md new file mode 100644 index 0000000..bbd691d --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/change-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[changeScope](change-scope.md) + +# changeScope + +[common]\ +open override fun [changeScope](change-scope.md)(to: [Scope](index.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-key.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-key.md new file mode 100644 index 0000000..c6fce79 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-key.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[currentKey](current-key.md) + +# currentKey + +[common]\ +open override val [currentKey](current-key.md): [Key](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-scope.md new file mode 100644 index 0000000..20d9845 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[currentScope](current-scope.md) + +# currentScope + +[common]\ +open override val [currentScope](current-scope.md): [Scope](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-back.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-back.md new file mode 100644 index 0000000..e002496 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-back.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[goBack](go-back.md) + +# goBack + +[common]\ +open override fun [goBack](go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-to.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-to.md new file mode 100644 index 0000000..12dee83 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-to.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[goTo](go-to.md) + +# goTo + +[common]\ +open override fun [goTo](go-to.md)(key: [Key](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/index.md new file mode 100644 index 0000000..7a361f8 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/index.md @@ -0,0 +1,36 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md) + +# BaseComposeNavigatorByKeyViewModel + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +abstract class [BaseComposeNavigatorByKeyViewModel](index.md)<[Scope](index.md), [Key](index.md), [NavigationScope](index.md) : [ComposeNavigationKeyScope](../-compose-navigation-key-scope/index.md)<[Key](index.md)>>(initialScope: [Scope](index.md), initialKeys: ([Scope](index.md)) -> [Key](index.md)) : ViewModel, [ComposeNavigator](../-compose-navigator/index.md)<[Key](index.md)> , [ComposeNavigatorByKey](../-compose-navigator-by-key/index.md)<[Key](index.md)> , [ComposeStackNavigatorByKey](../-compose-stack-navigator-by-key/index.md)<[Key](index.md)> , [ComposeScopedNavigator](../-compose-scoped-navigator/index.md)<[Scope](index.md), [Key](index.md)> + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](can-go-back.md) | [common]
open override fun [canGoBack](can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [changeScope](change-scope.md) | [common]
open override fun [changeScope](change-scope.md)(to: [Scope](index.md)) | +| [goBack](go-back.md) | [common]
open override fun [goBack](go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](go-to.md) | [common]
open override fun [goTo](go-to.md)(key: [Key](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](current-key.md) | [common]
open override val [currentKey](current-key.md): [Key](index.md) | +| [currentScope](current-scope.md) | [common]
open override val [currentScope](current-scope.md): [Scope](index.md) | +| [initialKey](initial-key.md) | [common]
override val [initialKey](initial-key.md): [Key](index.md) | +| [initialScope](initial-scope.md) | [common]
override val [initialScope](initial-scope.md): [Scope](index.md) | +| [isInitialized](is-initialized.md) | [common]
open override var [isInitialized](is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false | +| [keyChanges](key-changes.md) | [common]
open override val [keyChanges](key-changes.md): Flow<[Key](index.md)> | +| [scopeChanges](scope-changes.md) | [common]
open override val [scopeChanges](scope-changes.md): Flow<[Scope](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeNavigationIntentNavigatorByKeyViewModel](../-compose-navigation-intent-navigator-by-key-view-model/index.md) | +| [ComposeNavigatorByKeyViewModel](../-compose-navigator-by-key-view-model/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-key.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-key.md new file mode 100644 index 0000000..7a446fa --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-key.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[initialKey](initial-key.md) + +# initialKey + +[common]\ +override val [initialKey](initial-key.md): [Key](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-scope.md new file mode 100644 index 0000000..081f758 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[initialScope](initial-scope.md) + +# initialScope + +[common]\ +override val [initialScope](initial-scope.md): [Scope](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/is-initialized.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/is-initialized.md new file mode 100644 index 0000000..dc34555 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/is-initialized.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[isInitialized](is-initialized.md) + +# isInitialized + +[common]\ +open override var [isInitialized](is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/key-changes.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/key-changes.md new file mode 100644 index 0000000..cae31ba --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/key-changes.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[keyChanges](key-changes.md) + +# keyChanges + +[common]\ +open override val [keyChanges](key-changes.md): Flow<[Key](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/scope-changes.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/scope-changes.md new file mode 100644 index 0000000..fc11ccb --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/scope-changes.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[BaseComposeNavigatorByKeyViewModel](index.md)/[scopeChanges](scope-changes.md) + +# scopeChanges + +[common]\ +open override val [scopeChanges](scope-changes.md): Flow<[Scope](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/-companion/index.md new file mode 100644 index 0000000..2616626 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigationContentScope](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/index.md new file mode 100644 index 0000000..a5ef6eb --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/index.md @@ -0,0 +1,20 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationContentScope](index.md) + +# ComposeNavigationContentScope + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigationContentScope](index.md)<[K](index.md)> : [ComposeNavigationScope](../-compose-navigation-scope/index.md) + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [navigator](navigator.md) | [common]
abstract val [navigator](navigator.md): [ComposeStackNavigatorByContent](../-compose-stack-navigator-by-content/index.md)<[K](index.md)> | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/navigator.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/navigator.md new file mode 100644 index 0000000..3cbfb46 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/navigator.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationContentScope](index.md)/[navigator](navigator.md) + +# navigator + +[common]\ +abstract val [navigator](navigator.md): [ComposeStackNavigatorByContent](../-compose-stack-navigator-by-content/index.md)<[K](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-navigator-by-key-view-model/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-navigator-by-key-view-model/index.md new file mode 100644 index 0000000..0c665b3 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-navigator-by-key-view-model/index.md @@ -0,0 +1,34 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentNavigatorByKeyViewModel](index.md) + +# ComposeNavigationIntentNavigatorByKeyViewModel + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +class [ComposeNavigationIntentNavigatorByKeyViewModel](index.md)<[Scope](index.md), [Intent](index.md) : [NavigationIntent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [BaseComposeNavigatorByKeyViewModel](../-base-compose-navigator-by-key-view-model/index.md)<[Scope](index.md), [Intent](index.md), [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[Intent](index.md)>> , [ComposeNavigationIntentStackNavigatorByKey](../-compose-navigation-intent-stack-navigator-by-key/index.md)<[Intent](index.md)> + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](../-base-compose-navigator-by-key-view-model/can-go-back.md) | [common]
open override fun [canGoBack](../-base-compose-navigator-by-key-view-model/can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [changeScope](../-base-compose-navigator-by-key-view-model/change-scope.md) | [common]
open override fun [changeScope](../-base-compose-navigator-by-key-view-model/change-scope.md)(to: [Scope](index.md)) | +| [goBack](../-base-compose-navigator-by-key-view-model/go-back.md) | [common]
open override fun [goBack](../-base-compose-navigator-by-key-view-model/go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](index.md#-1944187993%2FFunctions%2F-1093353005) | [common]
open override fun [goTo](index.md#-1944187993%2FFunctions%2F-1093353005)(key: [Intent](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) | +| [navigate](../-compose-navigation-intent-stack-navigator-by-key/navigate.md) | [common]
open override fun [navigate](../-compose-navigation-intent-stack-navigator-by-key/navigate.md)(event: [NavigationEvent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md)<[Intent](index.md)>) | +| [onGoBack](../-compose-navigation-intent-stack-navigator-by-key/on-go-back.md) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[Intent](index.md)>.[onGoBack](../-compose-navigation-intent-stack-navigator-by-key/on-go-back.md)() | +| [onGoTo](../-compose-navigation-intent-stack-navigator-by-key/on-go-to.md) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[Intent](index.md)>.[onGoTo](../-compose-navigation-intent-stack-navigator-by-key/on-go-to.md)(intent: [Intent](index.md)) | +| [onGoUp](../-compose-navigation-intent-stack-navigator-by-key/on-go-up.md) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[Intent](index.md)>.[onGoUp](../-compose-navigation-intent-stack-navigator-by-key/on-go-up.md)() | +| [onNavigate](index.md#815856985%2FFunctions%2F-1093353005) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[Intent](index.md)>.[onNavigate](index.md#815856985%2FFunctions%2F-1093353005)(event: [NavigationEvent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md)<[Intent](index.md)>) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-base-compose-navigator-by-key-view-model/current-key.md) | [common]
open override val [currentKey](../-base-compose-navigator-by-key-view-model/current-key.md): [Intent](index.md) | +| [currentScope](../-base-compose-navigator-by-key-view-model/current-scope.md) | [common]
open override val [currentScope](../-base-compose-navigator-by-key-view-model/current-scope.md): [Scope](index.md) | +| [initialKey](../-base-compose-navigator-by-key-view-model/initial-key.md) | [common]
override val [initialKey](../-base-compose-navigator-by-key-view-model/initial-key.md): [Intent](index.md) | +| [initialScope](../-base-compose-navigator-by-key-view-model/initial-scope.md) | [common]
override val [initialScope](../-base-compose-navigator-by-key-view-model/initial-scope.md): [Scope](index.md) | +| [isInitialized](../-base-compose-navigator-by-key-view-model/is-initialized.md) | [common]
open override var [isInitialized](../-base-compose-navigator-by-key-view-model/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-base-compose-navigator-by-key-view-model/key-changes.md) | [common]
open override val [keyChanges](../-base-compose-navigator-by-key-view-model/key-changes.md): Flow<[Intent](index.md)> | +| [scopeChanges](../-base-compose-navigator-by-key-view-model/scope-changes.md) | [common]
open override val [scopeChanges](../-base-compose-navigator-by-key-view-model/scope-changes.md): Flow<[Scope](index.md)> | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/-companion/index.md new file mode 100644 index 0000000..7d5fe29 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigationIntentScope](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/index.md new file mode 100644 index 0000000..e81ba09 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/index.md @@ -0,0 +1,20 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentScope](index.md) + +# ComposeNavigationIntentScope + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigationIntentScope](index.md)<[I](index.md) : [NavigationIntent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [ComposeNavigationKeyScope](../-compose-navigation-key-scope/index.md)<[I](index.md)> + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [navigator](navigator.md) | [common]
abstract override val [navigator](navigator.md): [ComposeNavigationIntentStackNavigatorByKey](../-compose-navigation-intent-stack-navigator-by-key/index.md)<[I](index.md)> | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/navigator.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/navigator.md new file mode 100644 index 0000000..6b07ff7 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/navigator.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentScope](index.md)/[navigator](navigator.md) + +# navigator + +[common]\ +abstract override val [navigator](navigator.md): [ComposeNavigationIntentStackNavigatorByKey](../-compose-navigation-intent-stack-navigator-by-key/index.md)<[I](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/index.md new file mode 100644 index 0000000..9d987c6 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/index.md @@ -0,0 +1,36 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentStackNavigatorByKey](index.md) + +# ComposeNavigationIntentStackNavigatorByKey + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigationIntentStackNavigatorByKey](index.md)<[I](index.md) : [NavigationIntent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [ComposeStackNavigatorByKey](../-compose-stack-navigator-by-key/index.md)<[I](index.md)> , [NavigationEventHandler](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/index.md)<[I](index.md), [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>> , [NavigationEventNavigator](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md)<[I](index.md)> + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](../-compose-stack-navigator/can-go-back.md) | [common]
abstract fun [canGoBack](../-compose-stack-navigator/can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goBack](../-compose-stack-navigator/go-back.md) | [common]
abstract fun [goBack](../-compose-stack-navigator/go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](index.md#1480498924%2FFunctions%2F-1093353005) | [common]
abstract fun [goTo](index.md#1480498924%2FFunctions%2F-1093353005)(key: [I](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) | +| [navigate](navigate.md) | [common]
open override fun [navigate](navigate.md)(event: [NavigationEvent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md)<[I](index.md)>) | +| [onGoBack](on-go-back.md) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>.[onGoBack](on-go-back.md)() | +| [onGoTo](on-go-to.md) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>.[onGoTo](on-go-to.md)(intent: [I](index.md)) | +| [onGoUp](on-go-up.md) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>.[onGoUp](on-go-up.md)() | +| [onNavigate](../-compose-navigation-intent-navigator-by-key-view-model/index.md#815856985%2FFunctions%2F-1093353005) | [common]
open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>.[onNavigate](../-compose-navigation-intent-navigator-by-key-view-model/index.md#815856985%2FFunctions%2F-1093353005)(event: [NavigationEvent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md)<[I](index.md)>) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [I](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [I](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[I](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeNavigationIntentNavigatorByKeyViewModel](../-compose-navigation-intent-navigator-by-key-view-model/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/navigate.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/navigate.md new file mode 100644 index 0000000..5158499 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/navigate.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentStackNavigatorByKey](index.md)/[navigate](navigate.md) + +# navigate + +[common]\ +open override fun [navigate](navigate.md)(event: [NavigationEvent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md)<[I](index.md)>) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-back.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-back.md new file mode 100644 index 0000000..5d00efd --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-back.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentStackNavigatorByKey](index.md)/[onGoBack](on-go-back.md) + +# onGoBack + +[common]\ +open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>.[onGoBack](on-go-back.md)() diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-to.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-to.md new file mode 100644 index 0000000..936c761 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-to.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentStackNavigatorByKey](index.md)/[onGoTo](on-go-to.md) + +# onGoTo + +[common]\ +open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>.[onGoTo](on-go-to.md)(intent: [I](index.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-up.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-up.md new file mode 100644 index 0000000..75bb3be --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-up.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationIntentStackNavigatorByKey](index.md)/[onGoUp](on-go-up.md) + +# onGoUp + +[common]\ +open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)<[I](index.md)>.[onGoUp](on-go-up.md)() diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/-companion/index.md new file mode 100644 index 0000000..719ae88 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigationKeyScope](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/index.md new file mode 100644 index 0000000..e3e8b79 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/index.md @@ -0,0 +1,26 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationKeyScope](index.md) + +# ComposeNavigationKeyScope + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigationKeyScope](index.md)<[K](index.md)> : [ComposeNavigationScope](../-compose-navigation-scope/index.md) + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [navigator](navigator.md) | [common]
abstract val [navigator](navigator.md): [ComposeStackNavigatorByKey](../-compose-stack-navigator-by-key/index.md)<[K](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/navigator.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/navigator.md new file mode 100644 index 0000000..adaae9e --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/navigator.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationKeyScope](index.md)/[navigator](navigator.md) + +# navigator + +[common]\ +abstract val [navigator](navigator.md): [ComposeStackNavigatorByKey](../-compose-stack-navigator-by-key/index.md)<[K](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/-companion/index.md new file mode 100644 index 0000000..0a13ad3 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigationScope](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) : [ComposeNavigationScope](../index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/index.md new file mode 100644 index 0000000..9b45aa9 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/index.md @@ -0,0 +1,22 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigationScope](index.md) + +# ComposeNavigationScope + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigationScope](index.md) : [NavigationScope](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md) + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) : [ComposeNavigationScope](index.md) | + +## Inheritors + +| Name | +|---| +| [ComposeNavigationScope](-companion/index.md) | +| [ComposeNavigationKeyScope](../-compose-navigation-key-scope/index.md) | +| [ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/can-go-back.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/can-go-back.md new file mode 100644 index 0000000..27ed866 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/can-go-back.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[canGoBack](can-go-back.md) + +# canGoBack + +[common]\ +open override fun [canGoBack](can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/change-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/change-scope.md new file mode 100644 index 0000000..42d125f --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/change-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[changeScope](change-scope.md) + +# changeScope + +[common]\ +open override fun [changeScope](change-scope.md)(to: [Scope](index.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-key.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-key.md new file mode 100644 index 0000000..9703264 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-key.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[currentKey](current-key.md) + +# currentKey + +[common]\ +open override val [currentKey](current-key.md): [Key](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-scope.md new file mode 100644 index 0000000..2fa8aa4 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[currentScope](current-scope.md) + +# currentScope + +[common]\ +open override val [currentScope](current-scope.md): [Scope](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-back.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-back.md new file mode 100644 index 0000000..1d84d52 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-back.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[goBack](go-back.md) + +# goBack + +[common]\ +open override fun [goBack](go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-to.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-to.md new file mode 100644 index 0000000..9b93d02 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-to.md @@ -0,0 +1,9 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[goTo](go-to.md) + +# goTo + +[common]\ + +@Composable + +open override fun [goTo](go-to.md)(key: [Key](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md), content: @Composable[ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md)<[Key](index.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/index.md new file mode 100644 index 0000000..56cc23b --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/index.md @@ -0,0 +1,29 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md) + +# ComposeNavigatorByContentViewModel + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +class [ComposeNavigatorByContentViewModel](index.md)<[Scope](index.md), [Key](index.md)> : [BaseComposeNavigatorByContentViewModel](../-base-compose-navigator-by-content-view-model/index.md)<[Scope](index.md), [Key](index.md)> + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](can-go-back.md) | [common]
open override fun [canGoBack](can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [changeScope](change-scope.md) | [common]
open override fun [changeScope](change-scope.md)(to: [Scope](index.md)) | +| [goBack](go-back.md) | [common]
open override fun [goBack](go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](go-to.md) | [common]
@Composable
open override fun [goTo](go-to.md)(key: [Key](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md), content: @Composable[ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md)<[Key](index.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](current-key.md) | [common]
open override val [currentKey](current-key.md): [Key](index.md) | +| [currentScope](current-scope.md) | [common]
open override val [currentScope](current-scope.md): [Scope](index.md) | +| [initialKey](initial-key.md) | [common]
open override val [initialKey](initial-key.md): [Key](index.md) | +| [initialScope](initial-scope.md) | [common]
open override val [initialScope](initial-scope.md): [Scope](index.md) | +| [isInitialized](is-initialized.md) | [common]
open override var [isInitialized](is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false | +| [keyChanges](key-changes.md) | [common]
open override val [keyChanges](key-changes.md): Flow<[Key](index.md)> | +| [scopeChanges](scope-changes.md) | [common]
open override val [scopeChanges](scope-changes.md): Flow<[Scope](index.md)> | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-key.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-key.md new file mode 100644 index 0000000..eb216a9 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-key.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[initialKey](initial-key.md) + +# initialKey + +[common]\ +open override val [initialKey](initial-key.md): [Key](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-scope.md new file mode 100644 index 0000000..a424f26 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[initialScope](initial-scope.md) + +# initialScope + +[common]\ +open override val [initialScope](initial-scope.md): [Scope](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/is-initialized.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/is-initialized.md new file mode 100644 index 0000000..166dfb8 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/is-initialized.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[isInitialized](is-initialized.md) + +# isInitialized + +[common]\ +open override var [isInitialized](is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/key-changes.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/key-changes.md new file mode 100644 index 0000000..64ad586 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/key-changes.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[keyChanges](key-changes.md) + +# keyChanges + +[common]\ +open override val [keyChanges](key-changes.md): Flow<[Key](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/scope-changes.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/scope-changes.md new file mode 100644 index 0000000..d9a24a2 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/scope-changes.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContentViewModel](index.md)/[scopeChanges](scope-changes.md) + +# scopeChanges + +[common]\ +open override val [scopeChanges](scope-changes.md): Flow<[Scope](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/-companion/index.md new file mode 100644 index 0000000..3c09e56 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigatorByContent](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/go-to.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/go-to.md new file mode 100644 index 0000000..e7f4171 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/go-to.md @@ -0,0 +1,9 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContent](index.md)/[goTo](go-to.md) + +# goTo + +[common]\ + +@Composable + +abstract fun [goTo](go-to.md)(key: [T](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md), content: @Composable[ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md)<[T](index.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/index.md new file mode 100644 index 0000000..847dcf9 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/index.md @@ -0,0 +1,42 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByContent](index.md) + +# ComposeNavigatorByContent + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigatorByContent](index.md)<[T](index.md)> : [ComposeNavigator](../-compose-navigator/index.md)<[T](index.md)> + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [goTo](go-to.md) | [common]
@Composable
abstract fun [goTo](go-to.md)(key: [T](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md), content: @Composable[ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md)<[T](index.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [T](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [T](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[T](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeStackNavigatorByContent](../-compose-stack-navigator-by-content/index.md) | +| [BaseComposeNavigatorByContentViewModel](../-base-compose-navigator-by-content-view-model/index.md) | + +## Extensions + +| Name | Summary | +|---|---| +| [goTo](../go-to.md) | [common]
@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md)
@Composable
fun <[T](../go-to.md)> [ComposeNavigatorByContent](index.md)<[T](../go-to.md)>.[goTo](../go-to.md)(key: [T](../go-to.md), content: @Composable[ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md)<[T](../go-to.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key-view-model/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key-view-model/index.md new file mode 100644 index 0000000..37cbe69 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key-view-model/index.md @@ -0,0 +1,29 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByKeyViewModel](index.md) + +# ComposeNavigatorByKeyViewModel + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +class [ComposeNavigatorByKeyViewModel](index.md)<[Scope](index.md), [Key](index.md)> : [BaseComposeNavigatorByKeyViewModel](../-base-compose-navigator-by-key-view-model/index.md)<[Scope](index.md), [Key](index.md), [ComposeNavigationKeyScope](../-compose-navigation-key-scope/index.md)<[Key](index.md)>> + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](../-base-compose-navigator-by-key-view-model/can-go-back.md) | [common]
open override fun [canGoBack](../-base-compose-navigator-by-key-view-model/can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [changeScope](../-base-compose-navigator-by-key-view-model/change-scope.md) | [common]
open override fun [changeScope](../-base-compose-navigator-by-key-view-model/change-scope.md)(to: [Scope](index.md)) | +| [goBack](../-base-compose-navigator-by-key-view-model/go-back.md) | [common]
open override fun [goBack](../-base-compose-navigator-by-key-view-model/go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](../-base-compose-navigator-by-key-view-model/go-to.md) | [common]
open override fun [goTo](../-base-compose-navigator-by-key-view-model/go-to.md)(key: [Key](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-base-compose-navigator-by-key-view-model/current-key.md) | [common]
open override val [currentKey](../-base-compose-navigator-by-key-view-model/current-key.md): [Key](index.md) | +| [currentScope](../-base-compose-navigator-by-key-view-model/current-scope.md) | [common]
open override val [currentScope](../-base-compose-navigator-by-key-view-model/current-scope.md): [Scope](index.md) | +| [initialKey](../-base-compose-navigator-by-key-view-model/initial-key.md) | [common]
override val [initialKey](../-base-compose-navigator-by-key-view-model/initial-key.md): [Key](index.md) | +| [initialScope](../-base-compose-navigator-by-key-view-model/initial-scope.md) | [common]
override val [initialScope](../-base-compose-navigator-by-key-view-model/initial-scope.md): [Scope](index.md) | +| [isInitialized](../-base-compose-navigator-by-key-view-model/is-initialized.md) | [common]
open override var [isInitialized](../-base-compose-navigator-by-key-view-model/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-base-compose-navigator-by-key-view-model/key-changes.md) | [common]
open override val [keyChanges](../-base-compose-navigator-by-key-view-model/key-changes.md): Flow<[Key](index.md)> | +| [scopeChanges](../-base-compose-navigator-by-key-view-model/scope-changes.md) | [common]
open override val [scopeChanges](../-base-compose-navigator-by-key-view-model/scope-changes.md): Flow<[Scope](index.md)> | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/-companion/index.md new file mode 100644 index 0000000..b01332f --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigatorByKey](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/go-to.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/go-to.md new file mode 100644 index 0000000..f956e26 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/go-to.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByKey](index.md)/[goTo](go-to.md) + +# goTo + +[common]\ +abstract fun [goTo](go-to.md)(key: [T](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/index.md new file mode 100644 index 0000000..1791123 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/index.md @@ -0,0 +1,42 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigatorByKey](index.md) + +# ComposeNavigatorByKey + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigatorByKey](index.md)<[T](index.md)> : [ComposeNavigator](../-compose-navigator/index.md)<[T](index.md)> + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [goTo](go-to.md) | [common]
abstract fun [goTo](go-to.md)(key: [T](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [T](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [T](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[T](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeStackNavigatorByKey](../-compose-stack-navigator-by-key/index.md) | +| [BaseComposeNavigatorByKeyViewModel](../-base-compose-navigator-by-key-view-model/index.md) | + +## Extensions + +| Name | Summary | +|---|---| +| [goTo](../go-to.md) | [common]
@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md)
fun <[T](../go-to.md)> [ComposeNavigatorByKey](index.md)<[T](../go-to.md)>.[goTo](../go-to.md)(key: [T](../go-to.md)) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/-companion/index.md new file mode 100644 index 0000000..59242d8 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeNavigator](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/current-key.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/current-key.md new file mode 100644 index 0000000..2d9e453 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/current-key.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigator](index.md)/[currentKey](current-key.md) + +# currentKey + +[common]\ +abstract val [currentKey](current-key.md): [T](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/index.md new file mode 100644 index 0000000..17e860a --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/index.md @@ -0,0 +1,40 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigator](index.md) + +# ComposeNavigator + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeNavigator](index.md)<[T](index.md)> : [Navigator](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](current-key.md) | [common]
abstract val [currentKey](current-key.md): [T](index.md) | +| [initialKey](initial-key.md) | [common]
abstract val [initialKey](initial-key.md): [T](index.md) | +| [isInitialized](is-initialized.md) | [common]
abstract val [isInitialized](is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](key-changes.md) | [common]
abstract val [keyChanges](key-changes.md): Flow<[T](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeNavigatorByContent](../-compose-navigator-by-content/index.md) | +| [ComposeNavigatorByKey](../-compose-navigator-by-key/index.md) | +| [ComposeStackNavigator](../-compose-stack-navigator/index.md) | +| [ComposeScopedNavigator](../-compose-scoped-navigator/index.md) | +| [BaseComposeNavigatorByContentViewModel](../-base-compose-navigator-by-content-view-model/index.md) | +| [BaseComposeNavigatorByKeyViewModel](../-base-compose-navigator-by-key-view-model/index.md) | + +## Extensions + +| Name | Summary | +|---|---| +| [currentKeyAsState](../current-key-as-state.md) | [common]
@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md)
@Composable
fun <[Key](../current-key-as-state.md)> [ComposeNavigator](index.md)<[Key](../current-key-as-state.md)>.[currentKeyAsState](../current-key-as-state.md)(initialCurrentKey: [Key](../current-key-as-state.md)): State<[Key](../current-key-as-state.md)>
@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md)
@Composable
fun <[Key](../current-key-as-state.md)> [ComposeNavigator](index.md)<[Key](../current-key-as-state.md)>.[currentKeyAsState](../current-key-as-state.md)(): State<[Key](../current-key-as-state.md)>
Obtains the changes to the [ComposeNavigator.currentKey](current-key.md) value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes. | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/initial-key.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/initial-key.md new file mode 100644 index 0000000..c36fbaf --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/initial-key.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigator](index.md)/[initialKey](initial-key.md) + +# initialKey + +[common]\ +abstract val [initialKey](initial-key.md): [T](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/is-initialized.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/is-initialized.md new file mode 100644 index 0000000..8413612 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/is-initialized.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigator](index.md)/[isInitialized](is-initialized.md) + +# isInitialized + +[common]\ +abstract val [isInitialized](is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/key-changes.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/key-changes.md new file mode 100644 index 0000000..8d02d50 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/key-changes.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeNavigator](index.md)/[keyChanges](key-changes.md) + +# keyChanges + +[common]\ +abstract val [keyChanges](key-changes.md): Flow<[T](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/-companion/index.md new file mode 100644 index 0000000..758d9ad --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeScopedNavigator](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/change-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/change-scope.md new file mode 100644 index 0000000..9712102 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/change-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeScopedNavigator](index.md)/[changeScope](change-scope.md) + +# changeScope + +[common]\ +abstract fun [changeScope](change-scope.md)(to: [Scope](index.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/current-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/current-scope.md new file mode 100644 index 0000000..0f1ca90 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/current-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeScopedNavigator](index.md)/[currentScope](current-scope.md) + +# currentScope + +[common]\ +abstract val [currentScope](current-scope.md): [Scope](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/index.md new file mode 100644 index 0000000..66eba20 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/index.md @@ -0,0 +1,45 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeScopedNavigator](index.md) + +# ComposeScopedNavigator + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeScopedNavigator](index.md)<[Scope](index.md), [Key](index.md)> : [ComposeNavigator](../-compose-navigator/index.md)<[Key](index.md)> + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [changeScope](change-scope.md) | [common]
abstract fun [changeScope](change-scope.md)(to: [Scope](index.md)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [Key](index.md) | +| [currentScope](current-scope.md) | [common]
abstract val [currentScope](current-scope.md): [Scope](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [Key](index.md) | +| [initialScope](initial-scope.md) | [common]
abstract val [initialScope](initial-scope.md): [Scope](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[Key](index.md)> | +| [scopeChanges](scope-changes.md) | [common]
abstract val [scopeChanges](scope-changes.md): Flow<[Scope](index.md)> | + +## Inheritors + +| Name | +|---| +| [BaseComposeNavigatorByContentViewModel](../-base-compose-navigator-by-content-view-model/index.md) | +| [BaseComposeNavigatorByKeyViewModel](../-base-compose-navigator-by-key-view-model/index.md) | + +## Extensions + +| Name | Summary | +|---|---| +| [currentScopeAsState](../current-scope-as-state.md) | [common]
@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md)
@Composable
fun <[Scope](../current-scope-as-state.md), [Key](../current-scope-as-state.md)> [ComposeScopedNavigator](index.md)<[Scope](../current-scope-as-state.md), [Key](../current-scope-as-state.md)>.[currentScopeAsState](../current-scope-as-state.md)(initialCurrentScope: [Scope](../current-scope-as-state.md)): State<[Scope](../current-scope-as-state.md)>
@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md)
@Composable
fun <[Scope](../current-scope-as-state.md), [Key](../current-scope-as-state.md)> [ComposeScopedNavigator](index.md)<[Scope](../current-scope-as-state.md), [Key](../current-scope-as-state.md)>.[currentScopeAsState](../current-scope-as-state.md)(): State<[Scope](../current-scope-as-state.md)>
Obtains the changes to the [ComposeScopedNavigator.currentScope](current-scope.md) value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes. | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/initial-scope.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/initial-scope.md new file mode 100644 index 0000000..b70384c --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/initial-scope.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeScopedNavigator](index.md)/[initialScope](initial-scope.md) + +# initialScope + +[common]\ +abstract val [initialScope](initial-scope.md): [Scope](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/scope-changes.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/scope-changes.md new file mode 100644 index 0000000..a46a1a2 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/scope-changes.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeScopedNavigator](index.md)/[scopeChanges](scope-changes.md) + +# scopeChanges + +[common]\ +abstract val [scopeChanges](scope-changes.md): Flow<[Scope](index.md)> diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/-companion/index.md new file mode 100644 index 0000000..6ea273f --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeStackNavigatorByContent](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/index.md new file mode 100644 index 0000000..f0439db --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/index.md @@ -0,0 +1,37 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeStackNavigatorByContent](index.md) + +# ComposeStackNavigatorByContent + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeStackNavigatorByContent](index.md)<[T](index.md)> : [ComposeStackNavigator](../-compose-stack-navigator/index.md)<[T](index.md)> , [ComposeNavigatorByContent](../-compose-navigator-by-content/index.md)<[T](index.md)> + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](../-compose-stack-navigator/can-go-back.md) | [common]
abstract fun [canGoBack](../-compose-stack-navigator/can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goBack](../-compose-stack-navigator/go-back.md) | [common]
abstract fun [goBack](../-compose-stack-navigator/go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](../-compose-navigator-by-content/go-to.md) | [common]
@Composable
abstract fun [goTo](../-compose-navigator-by-content/go-to.md)(key: [T](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md), content: @Composable[ComposeNavigationContentScope](../-compose-navigation-content-scope/index.md)<[T](index.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [T](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [T](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[T](index.md)> | + +## Inheritors + +| Name | +|---| +| [BaseComposeNavigatorByContentViewModel](../-base-compose-navigator-by-content-view-model/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/-companion/index.md new file mode 100644 index 0000000..fea8910 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeStackNavigatorByKey](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/index.md new file mode 100644 index 0000000..98726fe --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/index.md @@ -0,0 +1,38 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeStackNavigatorByKey](index.md) + +# ComposeStackNavigatorByKey + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeStackNavigatorByKey](index.md)<[T](index.md)> : [ComposeStackNavigator](../-compose-stack-navigator/index.md)<[T](index.md)> , [ComposeNavigatorByKey](../-compose-navigator-by-key/index.md)<[T](index.md)> + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](../-compose-stack-navigator/can-go-back.md) | [common]
abstract fun [canGoBack](../-compose-stack-navigator/can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goBack](../-compose-stack-navigator/go-back.md) | [common]
abstract fun [goBack](../-compose-stack-navigator/go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goTo](../-compose-navigator-by-key/go-to.md) | [common]
abstract fun [goTo](../-compose-navigator-by-key/go-to.md)(key: [T](index.md), strategy: [NavStackDuplicateContentStrategy](../../../../navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md)) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [T](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [T](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[T](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeNavigationIntentStackNavigatorByKey](../-compose-navigation-intent-stack-navigator-by-key/index.md) | +| [BaseComposeNavigatorByKeyViewModel](../-base-compose-navigator-by-key-view-model/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/-companion/index.md new file mode 100644 index 0000000..b71a535 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[ComposeStackNavigator](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/can-go-back.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/can-go-back.md new file mode 100644 index 0000000..4fc26f5 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/can-go-back.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeStackNavigator](index.md)/[canGoBack](can-go-back.md) + +# canGoBack + +[common]\ +abstract fun [canGoBack](can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/go-back.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/go-back.md new file mode 100644 index 0000000..26d9a87 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/go-back.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeStackNavigator](index.md)/[goBack](go-back.md) + +# goBack + +[common]\ +abstract fun [goBack](go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/index.md new file mode 100644 index 0000000..da77ca2 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/index.md @@ -0,0 +1,37 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ComposeStackNavigator](index.md) + +# ComposeStackNavigator + +[common]\ +@[ExperimentalNavigationApi](../-experimental-navigation-api/index.md) + +interface [ComposeStackNavigator](index.md)<[T](index.md)> : [ComposeNavigator](../-compose-navigator/index.md)<[T](index.md)> + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [canGoBack](can-go-back.md) | [common]
abstract fun [canGoBack](can-go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [goBack](go-back.md) | [common]
abstract fun [goBack](go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | + +## Properties + +| Name | Summary | +|---|---| +| [currentKey](../-compose-navigator/current-key.md) | [common]
abstract val [currentKey](../-compose-navigator/current-key.md): [T](index.md) | +| [initialKey](../-compose-navigator/initial-key.md) | [common]
abstract val [initialKey](../-compose-navigator/initial-key.md): [T](index.md) | +| [isInitialized](../-compose-navigator/is-initialized.md) | [common]
abstract val [isInitialized](../-compose-navigator/is-initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [keyChanges](../-compose-navigator/key-changes.md) | [common]
abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow<[T](index.md)> | + +## Inheritors + +| Name | +|---| +| [ComposeStackNavigatorByContent](../-compose-stack-navigator-by-content/index.md) | +| [ComposeStackNavigatorByKey](../-compose-stack-navigator-by-key/index.md) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/-experimental-navigation-api.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/-experimental-navigation-api.md new file mode 100644 index 0000000..7278017 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/-experimental-navigation-api.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ExperimentalNavigationApi](index.md)/[ExperimentalNavigationApi](-experimental-navigation-api.md) + +# ExperimentalNavigationApi + +[common]\ +fun [ExperimentalNavigationApi](-experimental-navigation-api.md)() diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/index.md new file mode 100644 index 0000000..32525ba --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/index.md @@ -0,0 +1,16 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[ExperimentalNavigationApi](index.md) + +# ExperimentalNavigationApi + +[common]\ +@[Target](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html)(allowedTargets = [[AnnotationTarget.CLASS](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-c-l-a-s-s/index.html), [AnnotationTarget.FUNCTION](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html), [AnnotationTarget.FIELD](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-i-e-l-d/index.html), [AnnotationTarget.PROPERTY](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y/index.html)]) + +annotation class [ExperimentalNavigationApi](index.md) + +Indicates that the component annotated with this annotation is experimental and could change or be removed in the future. + +## Constructors + +| | | +|---|---| +| [ExperimentalNavigationApi](-experimental-navigation-api.md) | [common]
fun [ExperimentalNavigationApi](-experimental-navigation-api.md)() | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-companion/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-companion/index.md new file mode 100644 index 0000000..5a4fd9a --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[NavBackStrategy](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-e-v-e-n-t/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-e-v-e-n-t/index.md new file mode 100644 index 0000000..00108d2 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-e-v-e-n-t/index.md @@ -0,0 +1,13 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[NavBackStrategy](../index.md)/[EVENT](index.md) + +# EVENT + +[common]\ +[EVENT](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](index.md#-372974862%2FProperties%2F-1093353005) | [common]
val [name](index.md#-372974862%2FProperties%2F-1093353005): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](index.md#-739389684%2FProperties%2F-1093353005) | [common]
val [ordinal](index.md#-739389684%2FProperties%2F-1093353005): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-s-t-a-c-k/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-s-t-a-c-k/index.md new file mode 100644 index 0000000..f9f1855 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-s-t-a-c-k/index.md @@ -0,0 +1,13 @@ +//[navigation-compose](../../../../index.md)/[com.chrynan.navigation.compose](../../index.md)/[NavBackStrategy](../index.md)/[STACK](index.md) + +# STACK + +[common]\ +[STACK](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../-e-v-e-n-t/index.md#-372974862%2FProperties%2F-1093353005) | [common]
val [name](../-e-v-e-n-t/index.md#-372974862%2FProperties%2F-1093353005): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-e-v-e-n-t/index.md#-739389684%2FProperties%2F-1093353005) | [common]
val [ordinal](../-e-v-e-n-t/index.md#-739389684%2FProperties%2F-1093353005): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/index.md new file mode 100644 index 0000000..549ab40 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/index.md @@ -0,0 +1,26 @@ +//[navigation-compose](../../../index.md)/[com.chrynan.navigation.compose](../index.md)/[NavBackStrategy](index.md) + +# NavBackStrategy + +[common]\ +enum [NavBackStrategy](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NavBackStrategy](index.md)> + +## Entries + +| | | +|---|---| +| [STACK](-s-t-a-c-k/index.md) | [common]
[STACK](-s-t-a-c-k/index.md)() | +| [EVENT](-e-v-e-n-t/index.md) | [common]
[EVENT](-e-v-e-n-t/index.md)() | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [name](-e-v-e-n-t/index.md#-372974862%2FProperties%2F-1093353005) | [common]
val [name](-e-v-e-n-t/index.md#-372974862%2FProperties%2F-1093353005): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](-e-v-e-n-t/index.md#-739389684%2FProperties%2F-1093353005) | [common]
val [ordinal](-e-v-e-n-t/index.md#-739389684%2FProperties%2F-1093353005): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-container.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-container.md new file mode 100644 index 0000000..a537ac4 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-container.md @@ -0,0 +1,104 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md)/[NavContainer](-nav-container.md) + +# NavContainer + +[common]\ + +@Composable + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +fun <[Scope](-nav-container.md), [Key](-nav-container.md)> [NavContainer](-nav-container.md)(navigator: [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md)<[Scope](-nav-container.md), [Key](-nav-container.md)>) + +Displays the content from a [navigator](-nav-container.md) in this Composable UI Container. + +When the [navigator](-nav-container.md) changes its content, even outside this [NavContainer](-nav-container.md), it will be reflected within this UI container. + +Example usage: + +val navigator = rememberNavigatorByContent("Greeting") { Text("Hello") }\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello".\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good-bye" after the following call:\ +navigator.goTo("Farewell") { Text("Good-bye") } + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByContent](remember-navigator-by-content.md) | | + +[common]\ + +@Composable + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +fun <[Scope](-nav-container.md), [Key](-nav-container.md)> [NavContainer](-nav-container.md)(navigator: [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md)<[Scope](-nav-container.md), [Key](-nav-container.md)>) + +Displays the content from a [navigator](-nav-container.md) in this Composable UI Container. + +When the [navigator](-nav-container.md) changes its content, even outside this [NavContainer](-nav-container.md), it will be reflected within this UI container. + +Example usage: + +val navigator = rememberNavigatorByKey("Greeting") { key ->\ + when(key) {\ + "Greeting" -> Text("Hello")\ + "Farewell" -> Text("Good-bye")\ + else -> Text("Unexpected Key: $key")\ + }\ +}\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello"\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good Bye" after the following call:\ +navigator.goTo("Farewell") + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByKey](remember-navigator-by-key.md) | | + +[common]\ + +@Composable + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +fun <[Scope](-nav-container.md), [Intent](-nav-container.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [NavContainer](-nav-container.md)(navigator: [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md)<[Scope](-nav-container.md), [Intent](-nav-container.md)>) + +Displays the content from a [navigator](-nav-container.md) in this Composable UI Container. + +When the [navigator](-nav-container.md) changes its content, even outside this [NavContainer](-nav-container.md), it will be reflected within this UI container. + +Example usage: + +val navigator = rememberNavigatorByKey(HomeNavigationIntent.Greeting) { navigationIntent ->\ + when(navigationIntent) {\ + HomeNavigationIntent.Greeting -> Text("Hello")\ + HomeNavigationIntent.Farewell -> Text("Good-bye")\ + }\ +}\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello"\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good Bye" after the following call:\ +navigator.goTo(HomeNavigationIntent.Farewell) + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByIntent](remember-navigator-by-intent.md) | | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-key-as-state.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-key-as-state.md new file mode 100644 index 0000000..499be57 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-key-as-state.md @@ -0,0 +1,32 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md)/[currentKeyAsState](current-key-as-state.md) + +# currentKeyAsState + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Key](current-key-as-state.md)> [ComposeNavigator](-compose-navigator/index.md)<[Key](current-key-as-state.md)>.[currentKeyAsState](current-key-as-state.md)(initialCurrentKey: [Key](current-key-as-state.md)): State<[Key](current-key-as-state.md)> + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Key](current-key-as-state.md)> [ComposeNavigator](-compose-navigator/index.md)<[Key](current-key-as-state.md)>.[currentKeyAsState](current-key-as-state.md)(): State<[Key](current-key-as-state.md)> + +Obtains the changes to the [ComposeNavigator.currentKey](-compose-navigator/current-key.md) value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes. + +If you just need to get the current key value and do not need to cause recomposition when the value changes, simply use the [ComposeNavigator.currentKey](-compose-navigator/current-key.md) property. + +**Note:** Internally this function uses the [ComposeNavigator.keyChanges](-compose-navigator/key-changes.md) Flow and the collectAsState function using the [ComposeNavigator.currentKey](-compose-navigator/current-key.md) as the initial value. + +## See also + +common + +| | | +|---|---| +| [com.chrynan.navigation.compose.ComposeNavigator](-compose-navigator/key-changes.md) | | +| collectAsState | | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-scope-as-state.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-scope-as-state.md new file mode 100644 index 0000000..3863ba4 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-scope-as-state.md @@ -0,0 +1,32 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md)/[currentScopeAsState](current-scope-as-state.md) + +# currentScopeAsState + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)> [ComposeScopedNavigator](-compose-scoped-navigator/index.md)<[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)>.[currentScopeAsState](current-scope-as-state.md)(initialCurrentScope: [Scope](current-scope-as-state.md)): State<[Scope](current-scope-as-state.md)> + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)> [ComposeScopedNavigator](-compose-scoped-navigator/index.md)<[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)>.[currentScopeAsState](current-scope-as-state.md)(): State<[Scope](current-scope-as-state.md)> + +Obtains the changes to the [ComposeScopedNavigator.currentScope](-compose-scoped-navigator/current-scope.md) value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes. + +If you just need to get the current scope value and do not need to cause recomposition when the value changes, simply use the [ComposeScopedNavigator.currentScope](-compose-scoped-navigator/current-scope.md) property. + +**Note:** Internally this function uses the [ComposeScopedNavigator.scopeChanges](-compose-scoped-navigator/scope-changes.md) Flow and the collectAsState function using the [ComposeScopedNavigator.currentScope](-compose-scoped-navigator/current-scope.md) as the initial value. + +## See also + +common + +| | | +|---|---| +| [com.chrynan.navigation.compose.ComposeScopedNavigator](-compose-scoped-navigator/scope-changes.md) | | +| collectAsState | | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/go-to.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/go-to.md new file mode 100644 index 0000000..2c76734 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/go-to.md @@ -0,0 +1,15 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md)/[goTo](go-to.md) + +# goTo + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[T](go-to.md)> [ComposeNavigatorByContent](-compose-navigator-by-content/index.md)<[T](go-to.md)>.[goTo](go-to.md)(key: [T](go-to.md), content: @Composable[ComposeNavigationContentScope](-compose-navigation-content-scope/index.md)<[T](go-to.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +fun <[T](go-to.md)> [ComposeNavigatorByKey](-compose-navigator-by-key/index.md)<[T](go-to.md)>.[goTo](go-to.md)(key: [T](go-to.md)) diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/index.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/index.md new file mode 100644 index 0000000..78672c6 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/index.md @@ -0,0 +1,39 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md) + +# Package com.chrynan.navigation.compose + +## Types + +| Name | Summary | +|---|---| +| [BaseComposeNavigatorByContentViewModel](-base-compose-navigator-by-content-view-model/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
abstract class [BaseComposeNavigatorByContentViewModel](-base-compose-navigator-by-content-view-model/index.md)<[Scope](-base-compose-navigator-by-content-view-model/index.md), [Key](-base-compose-navigator-by-content-view-model/index.md)> : ViewModel, [ComposeNavigator](-compose-navigator/index.md)<[Key](-base-compose-navigator-by-content-view-model/index.md)> , [ComposeNavigatorByContent](-compose-navigator-by-content/index.md)<[Key](-base-compose-navigator-by-content-view-model/index.md)> , [ComposeStackNavigatorByContent](-compose-stack-navigator-by-content/index.md)<[Key](-base-compose-navigator-by-content-view-model/index.md)> , [ComposeScopedNavigator](-compose-scoped-navigator/index.md)<[Scope](-base-compose-navigator-by-content-view-model/index.md), [Key](-base-compose-navigator-by-content-view-model/index.md)> | +| [BaseComposeNavigatorByKeyViewModel](-base-compose-navigator-by-key-view-model/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
abstract class [BaseComposeNavigatorByKeyViewModel](-base-compose-navigator-by-key-view-model/index.md)<[Scope](-base-compose-navigator-by-key-view-model/index.md), [Key](-base-compose-navigator-by-key-view-model/index.md), [NavigationScope](-base-compose-navigator-by-key-view-model/index.md) : [ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[Key](-base-compose-navigator-by-key-view-model/index.md)>>(initialScope: [Scope](-base-compose-navigator-by-key-view-model/index.md), initialKeys: ([Scope](-base-compose-navigator-by-key-view-model/index.md)) -> [Key](-base-compose-navigator-by-key-view-model/index.md)) : ViewModel, [ComposeNavigator](-compose-navigator/index.md)<[Key](-base-compose-navigator-by-key-view-model/index.md)> , [ComposeNavigatorByKey](-compose-navigator-by-key/index.md)<[Key](-base-compose-navigator-by-key-view-model/index.md)> , [ComposeStackNavigatorByKey](-compose-stack-navigator-by-key/index.md)<[Key](-base-compose-navigator-by-key-view-model/index.md)> , [ComposeScopedNavigator](-compose-scoped-navigator/index.md)<[Scope](-base-compose-navigator-by-key-view-model/index.md), [Key](-base-compose-navigator-by-key-view-model/index.md)> | +| [ComposeNavigationContentScope](-compose-navigation-content-scope/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigationContentScope](-compose-navigation-content-scope/index.md)<[K](-compose-navigation-content-scope/index.md)> : [ComposeNavigationScope](-compose-navigation-scope/index.md) | +| [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
class [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md)<[Scope](-compose-navigation-intent-navigator-by-key-view-model/index.md), [Intent](-compose-navigation-intent-navigator-by-key-view-model/index.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [BaseComposeNavigatorByKeyViewModel](-base-compose-navigator-by-key-view-model/index.md)<[Scope](-compose-navigation-intent-navigator-by-key-view-model/index.md), [Intent](-compose-navigation-intent-navigator-by-key-view-model/index.md), [ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md)<[Intent](-compose-navigation-intent-navigator-by-key-view-model/index.md)>> , [ComposeNavigationIntentStackNavigatorByKey](-compose-navigation-intent-stack-navigator-by-key/index.md)<[Intent](-compose-navigation-intent-navigator-by-key-view-model/index.md)> | +| [ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md)<[I](-compose-navigation-intent-scope/index.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[I](-compose-navigation-intent-scope/index.md)> | +| [ComposeNavigationIntentStackNavigatorByKey](-compose-navigation-intent-stack-navigator-by-key/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigationIntentStackNavigatorByKey](-compose-navigation-intent-stack-navigator-by-key/index.md)<[I](-compose-navigation-intent-stack-navigator-by-key/index.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [ComposeStackNavigatorByKey](-compose-stack-navigator-by-key/index.md)<[I](-compose-navigation-intent-stack-navigator-by-key/index.md)> , [NavigationEventHandler](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/index.md)<[I](-compose-navigation-intent-stack-navigator-by-key/index.md), [ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md)<[I](-compose-navigation-intent-stack-navigator-by-key/index.md)>> , [NavigationEventNavigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md)<[I](-compose-navigation-intent-stack-navigator-by-key/index.md)> | +| [ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[K](-compose-navigation-key-scope/index.md)> : [ComposeNavigationScope](-compose-navigation-scope/index.md) | +| [ComposeNavigationScope](-compose-navigation-scope/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigationScope](-compose-navigation-scope/index.md) : [NavigationScope](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md) | +| [ComposeNavigator](-compose-navigator/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigator](-compose-navigator/index.md)<[T](-compose-navigator/index.md)> : [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) | +| [ComposeNavigatorByContent](-compose-navigator-by-content/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigatorByContent](-compose-navigator-by-content/index.md)<[T](-compose-navigator-by-content/index.md)> : [ComposeNavigator](-compose-navigator/index.md)<[T](-compose-navigator-by-content/index.md)> | +| [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
class [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md)<[Scope](-compose-navigator-by-content-view-model/index.md), [Key](-compose-navigator-by-content-view-model/index.md)> : [BaseComposeNavigatorByContentViewModel](-base-compose-navigator-by-content-view-model/index.md)<[Scope](-compose-navigator-by-content-view-model/index.md), [Key](-compose-navigator-by-content-view-model/index.md)> | +| [ComposeNavigatorByKey](-compose-navigator-by-key/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeNavigatorByKey](-compose-navigator-by-key/index.md)<[T](-compose-navigator-by-key/index.md)> : [ComposeNavigator](-compose-navigator/index.md)<[T](-compose-navigator-by-key/index.md)> | +| [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
class [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md)<[Scope](-compose-navigator-by-key-view-model/index.md), [Key](-compose-navigator-by-key-view-model/index.md)> : [BaseComposeNavigatorByKeyViewModel](-base-compose-navigator-by-key-view-model/index.md)<[Scope](-compose-navigator-by-key-view-model/index.md), [Key](-compose-navigator-by-key-view-model/index.md), [ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[Key](-compose-navigator-by-key-view-model/index.md)>> | +| [ComposeScopedNavigator](-compose-scoped-navigator/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeScopedNavigator](-compose-scoped-navigator/index.md)<[Scope](-compose-scoped-navigator/index.md), [Key](-compose-scoped-navigator/index.md)> : [ComposeNavigator](-compose-navigator/index.md)<[Key](-compose-scoped-navigator/index.md)> | +| [ComposeStackNavigator](-compose-stack-navigator/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeStackNavigator](-compose-stack-navigator/index.md)<[T](-compose-stack-navigator/index.md)> : [ComposeNavigator](-compose-navigator/index.md)<[T](-compose-stack-navigator/index.md)> | +| [ComposeStackNavigatorByContent](-compose-stack-navigator-by-content/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeStackNavigatorByContent](-compose-stack-navigator-by-content/index.md)<[T](-compose-stack-navigator-by-content/index.md)> : [ComposeStackNavigator](-compose-stack-navigator/index.md)<[T](-compose-stack-navigator-by-content/index.md)> , [ComposeNavigatorByContent](-compose-navigator-by-content/index.md)<[T](-compose-stack-navigator-by-content/index.md)> | +| [ComposeStackNavigatorByKey](-compose-stack-navigator-by-key/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
interface [ComposeStackNavigatorByKey](-compose-stack-navigator-by-key/index.md)<[T](-compose-stack-navigator-by-key/index.md)> : [ComposeStackNavigator](-compose-stack-navigator/index.md)<[T](-compose-stack-navigator-by-key/index.md)> , [ComposeNavigatorByKey](-compose-navigator-by-key/index.md)<[T](-compose-stack-navigator-by-key/index.md)> | +| [ExperimentalNavigationApi](-experimental-navigation-api/index.md) | [common]
@[Target](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html)(allowedTargets = [[AnnotationTarget.CLASS](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-c-l-a-s-s/index.html), [AnnotationTarget.FUNCTION](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-u-n-c-t-i-o-n/index.html), [AnnotationTarget.FIELD](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-i-e-l-d/index.html), [AnnotationTarget.PROPERTY](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-p-r-o-p-e-r-t-y/index.html)])
annotation class [ExperimentalNavigationApi](-experimental-navigation-api/index.md)
Indicates that the component annotated with this annotation is experimental and could change or be removed in the future. | +| [NavBackStrategy](-nav-back-strategy/index.md) | [common]
enum [NavBackStrategy](-nav-back-strategy/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NavBackStrategy](-nav-back-strategy/index.md)> | + +## Functions + +| Name | Summary | +|---|---| +| [currentKeyAsState](current-key-as-state.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Key](current-key-as-state.md)> [ComposeNavigator](-compose-navigator/index.md)<[Key](current-key-as-state.md)>.[currentKeyAsState](current-key-as-state.md)(): State<[Key](current-key-as-state.md)>
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Key](current-key-as-state.md)> [ComposeNavigator](-compose-navigator/index.md)<[Key](current-key-as-state.md)>.[currentKeyAsState](current-key-as-state.md)(initialCurrentKey: [Key](current-key-as-state.md)): State<[Key](current-key-as-state.md)>
Obtains the changes to the [ComposeNavigator.currentKey](-compose-navigator/current-key.md) value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes. | +| [currentScopeAsState](current-scope-as-state.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)> [ComposeScopedNavigator](-compose-scoped-navigator/index.md)<[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)>.[currentScopeAsState](current-scope-as-state.md)(): State<[Scope](current-scope-as-state.md)>
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)> [ComposeScopedNavigator](-compose-scoped-navigator/index.md)<[Scope](current-scope-as-state.md), [Key](current-scope-as-state.md)>.[currentScopeAsState](current-scope-as-state.md)(initialCurrentScope: [Scope](current-scope-as-state.md)): State<[Scope](current-scope-as-state.md)>
Obtains the changes to the [ComposeScopedNavigator.currentScope](-compose-scoped-navigator/current-scope.md) value and returns it as a State. This allows it to be used in a Composable and cause recomposition when the value changes. | +| [goTo](go-to.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
fun <[T](go-to.md)> [ComposeNavigatorByKey](-compose-navigator-by-key/index.md)<[T](go-to.md)>.[goTo](go-to.md)(key: [T](go-to.md))
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[T](go-to.md)> [ComposeNavigatorByContent](-compose-navigator-by-content/index.md)<[T](go-to.md)>.[goTo](go-to.md)(key: [T](go-to.md), content: @Composable[ComposeNavigationContentScope](-compose-navigation-content-scope/index.md)<[T](go-to.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) | +| [NavContainer](-nav-container.md) | [common]
@Composable
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
fun <[Scope](-nav-container.md), [Intent](-nav-container.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [NavContainer](-nav-container.md)(navigator: [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md)<[Scope](-nav-container.md), [Intent](-nav-container.md)>)
@Composable
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
fun <[Scope](-nav-container.md), [Key](-nav-container.md)> [NavContainer](-nav-container.md)(navigator: [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md)<[Scope](-nav-container.md), [Key](-nav-container.md)>)
@Composable
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
fun <[Scope](-nav-container.md), [Key](-nav-container.md)> [NavContainer](-nav-container.md)(navigator: [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md)<[Scope](-nav-container.md), [Key](-nav-container.md)>)
Displays the content from a [navigator](-nav-container.md) in this Composable UI Container. | +| [rememberNavigatorByContent](remember-navigator-by-content.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Scope](remember-navigator-by-content.md), [Key](remember-navigator-by-content.md)> [rememberNavigatorByContent](remember-navigator-by-content.md)(initialScope: [Scope](remember-navigator-by-content.md), initialKeysAndContent: ([Scope](remember-navigator-by-content.md)) -> [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[Key](remember-navigator-by-content.md), @Composable[ComposeNavigationContentScope](-compose-navigation-content-scope/index.md)<[Key](remember-navigator-by-content.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)>): [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md)<[Scope](remember-navigator-by-content.md), [Key](remember-navigator-by-content.md)>
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Key](remember-navigator-by-content.md)> [rememberNavigatorByContent](remember-navigator-by-content.md)(initialKey: [Key](remember-navigator-by-content.md), initialContent: @Composable[ComposeNavigationContentScope](-compose-navigation-content-scope/index.md)<[Key](remember-navigator-by-content.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)?, [Key](remember-navigator-by-content.md)>
Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a key and Composable content. This allows for explicitly specifying the Composable content to navigate to at the [ComposeNavigatorByContent.goTo](-compose-navigator-by-content/go-to.md) function call site. Meaning the Composable content is more flexible and doesn't need to specified upfront when creating this [ComposeNavigatorByContent](-compose-navigator-by-content/index.md). | +| [rememberNavigatorByIntent](remember-navigator-by-intent.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Intent](remember-navigator-by-intent.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [rememberNavigatorByIntent](remember-navigator-by-intent.md)(initialIntent: [Intent](remember-navigator-by-intent.md), content: @Composable[ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md)<[Intent](remember-navigator-by-intent.md)>.([Intent](remember-navigator-by-intent.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)?, [Intent](remember-navigator-by-intent.md)>
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Scope](remember-navigator-by-intent.md), [Intent](remember-navigator-by-intent.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [rememberNavigatorByIntent](remember-navigator-by-intent.md)(initialScope: [Scope](remember-navigator-by-intent.md), initialIntents: ([Scope](remember-navigator-by-intent.md)) -> [Intent](remember-navigator-by-intent.md), content: @Composable[ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md)<[Intent](remember-navigator-by-intent.md)>.([Intent](remember-navigator-by-intent.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md)<[Scope](remember-navigator-by-intent.md), [Intent](remember-navigator-by-intent.md)>
Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md) as a key. This allows for specifying the Composable content up front when creating this [ComposeNavigatorByKey](-compose-navigator-by-key/index.md) and simply navigating with a [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md) key from the [ComposeNavigatorByKey.goTo](-compose-navigator-by-key/go-to.md) function. The returned [ComposeNavigator](-compose-navigator/index.md) implements the [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) interface. | +| [rememberNavigatorByKey](remember-navigator-by-key.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Key](remember-navigator-by-key.md)> [rememberNavigatorByKey](remember-navigator-by-key.md)(initialKey: [Key](remember-navigator-by-key.md), content: @Composable[ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[Key](remember-navigator-by-key.md)>.([Key](remember-navigator-by-key.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)?, [Key](remember-navigator-by-key.md)>
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Composable
fun <[Scope](remember-navigator-by-key.md), [Key](remember-navigator-by-key.md)> [rememberNavigatorByKey](remember-navigator-by-key.md)(initialScope: [Scope](remember-navigator-by-key.md), initialKeys: ([Scope](remember-navigator-by-key.md)) -> [Key](remember-navigator-by-key.md), content: @Composable[ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[Key](remember-navigator-by-key.md)>.([Key](remember-navigator-by-key.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md)<[Scope](remember-navigator-by-key.md), [Key](remember-navigator-by-key.md)>
Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a key. This allows for specifying the Composable content up front when creating this [ComposeNavigatorByKey](-compose-navigator-by-key/index.md) and simply navigating with a key from the [ComposeNavigatorByKey.goTo](-compose-navigator-by-key/go-to.md) function. | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-content.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-content.md new file mode 100644 index 0000000..54e6993 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-content.md @@ -0,0 +1,80 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md)/[rememberNavigatorByContent](remember-navigator-by-content.md) + +# rememberNavigatorByContent + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Key](remember-navigator-by-content.md)> [rememberNavigatorByContent](remember-navigator-by-content.md)(initialKey: [Key](remember-navigator-by-content.md), initialContent: @Composable[ComposeNavigationContentScope](-compose-navigation-content-scope/index.md)<[Key](remember-navigator-by-content.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)?, [Key](remember-navigator-by-content.md)> + +Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a key and Composable content. This allows for explicitly specifying the Composable content to navigate to at the [ComposeNavigatorByContent.goTo](-compose-navigator-by-content/go-to.md) function call site. Meaning the Composable content is more flexible and doesn't need to specified upfront when creating this [ComposeNavigatorByContent](-compose-navigator-by-content/index.md). + +Example usage: + +val navigator = rememberNavigatorByContent("Greeting") { Text("Hello") }\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello".\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good-bye" after the following call:\ +navigator.goTo("Farewell") { Text("Good-bye") }\ +\ +// Goes back to the initial content: "Hello":\ +navigator.goBack() + +**Note:** That it is typical to use a [ComposeNavigator](-compose-navigator/index.md) with a [NavContainer](-nav-container.md) to display the Composable content and listen to changes. + +**Note:** This function differs slightly from the [rememberNavigatorByContent](remember-navigator-by-content.md) function in that it only uses a single scope of type [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html). This means that scopes cannot be changed on the returned [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md). + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByContent](remember-navigator-by-content.md) | | + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Scope](remember-navigator-by-content.md), [Key](remember-navigator-by-content.md)> [rememberNavigatorByContent](remember-navigator-by-content.md)(initialScope: [Scope](remember-navigator-by-content.md), initialKeysAndContent: ([Scope](remember-navigator-by-content.md)) -> [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[Key](remember-navigator-by-content.md), @Composable[ComposeNavigationContentScope](-compose-navigation-content-scope/index.md)<[Key](remember-navigator-by-content.md)>.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)>): [ComposeNavigatorByContentViewModel](-compose-navigator-by-content-view-model/index.md)<[Scope](remember-navigator-by-content.md), [Key](remember-navigator-by-content.md)> + +Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a key and Composable content. This allows for explicitly specifying the Composable content to navigate to at the [ComposeNavigatorByContent.goTo](-compose-navigator-by-content/go-to.md) function call site. Meaning the Composable content is more flexible and doesn't need to specified upfront when creating this [ComposeNavigatorByContent](-compose-navigator-by-content/index.md). + +Example usage: + +val navigator = rememberNavigatorByContent(\ + initialScope = BottomNavBarItem.HOME,\ + initialKeysAndContent = { scope ->\ + when (scope) {\ + is BottomNavBarItem.HOME -> "Greeting" to { Text("Hello") }\ + }\ + }\ + )\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello".\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good-bye" after the following call:\ +navigator.goTo("Farewell") { Text("Good-bye") }\ +\ +// Goes back to the initial content: "Hello":\ +navigator.goBack() + +**Note:** That it is typical to use a [ComposeNavigator](-compose-navigator/index.md) with a [NavContainer](-nav-container.md) to display the Composable content and listen to changes. + +**Note:** That this function differs slightly from the [rememberNavigatorByContent](remember-navigator-by-content.md) function in that this function allows changing of scopes, which is useful for more complex navigation. + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByContent](remember-navigator-by-content.md) | | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-intent.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-intent.md new file mode 100644 index 0000000..7031913 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-intent.md @@ -0,0 +1,93 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md)/[rememberNavigatorByIntent](remember-navigator-by-intent.md) + +# rememberNavigatorByIntent + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Intent](remember-navigator-by-intent.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [rememberNavigatorByIntent](remember-navigator-by-intent.md)(initialIntent: [Intent](remember-navigator-by-intent.md), content: @Composable[ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md)<[Intent](remember-navigator-by-intent.md)>.([Intent](remember-navigator-by-intent.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)?, [Intent](remember-navigator-by-intent.md)> + +Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md) as a key. This allows for specifying the Composable content up front when creating this [ComposeNavigatorByKey](-compose-navigator-by-key/index.md) and simply navigating with a [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md) key from the [ComposeNavigatorByKey.goTo](-compose-navigator-by-key/go-to.md) function. The returned [ComposeNavigator](-compose-navigator/index.md) implements the [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) interface. + +Example usage: + +val navigator = rememberNavigatorByKey(HomeNavigationIntent.Greeting) { navigationIntent ->\ + when(navigationIntent) {\ + HomeNavigationIntent.Greeting -> Text("Hello")\ + HomeNavigationIntent.Farewell -> Text("Good-bye")\ + }\ +}\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello"\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good Bye" after the following call:\ +navigator.goTo(HomeNavigationIntent.Farewell)\ +\ +// Goes back to the initial content: "Hello":\ +navigator.goBack() + +**Note:** That it is typical to use a [ComposeNavigator](-compose-navigator/index.md) with a [NavContainer](-nav-container.md) to display the Composable content and listen to changes. + +**Note:** This function differs slightly from the [rememberNavigatorByIntent](remember-navigator-by-intent.md) function in that it only uses a single scope of type [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html). This means that scopes cannot be changed on the returned [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md). + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByIntent](remember-navigator-by-intent.md) | | + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Scope](remember-navigator-by-intent.md), [Intent](remember-navigator-by-intent.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [rememberNavigatorByIntent](remember-navigator-by-intent.md)(initialScope: [Scope](remember-navigator-by-intent.md), initialIntents: ([Scope](remember-navigator-by-intent.md)) -> [Intent](remember-navigator-by-intent.md), content: @Composable[ComposeNavigationIntentScope](-compose-navigation-intent-scope/index.md)<[Intent](remember-navigator-by-intent.md)>.([Intent](remember-navigator-by-intent.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigationIntentNavigatorByKeyViewModel](-compose-navigation-intent-navigator-by-key-view-model/index.md)<[Scope](remember-navigator-by-intent.md), [Intent](remember-navigator-by-intent.md)> + +Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md) as a key. This allows for specifying the Composable content up front when creating this [ComposeNavigatorByKey](-compose-navigator-by-key/index.md) and simply navigating with a [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md) key from the [ComposeNavigatorByKey.goTo](-compose-navigator-by-key/go-to.md) function. The returned [ComposeNavigator](-compose-navigator/index.md) implements the [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) interface. + +Example usage: + +val navigator = rememberNavigatorByKey(\ + initialScope = BottomNavBarItem.HELLO,\ + initialKeys = { scope ->\ + when(scope) {\ + BottomNavBarItem.HELLO -> HomeNavigationIntent.Greeting\ + BottomNavBarItem.GOODBYE -> HomeNavigationIntent.Farewell\ + ...\ + }\ + },\ + content = { navigationIntent ->\ + when(navigationIntent) {\ + HomeNavigationIntent.Greeting -> Text("Hello")\ + HomeNavigationIntent.Farewell -> Text("Good-bye")\ + }\ + }\ +)\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello"\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good Bye" after the following call:\ +navigator.goTo(HomeNavigationIntent.Farewell)\ +\ +// Goes back to the initial content: "Hello":\ +navigator.goBack() + +**Note:** That it is typical to use a [ComposeNavigator](-compose-navigator/index.md) with a [NavContainer](-nav-container.md) to display the Composable content and listen to changes. + +**Note:** That this function differs slightly from the [rememberNavigatorByIntent](remember-navigator-by-intent.md) function in that this function allows changing of scopes, which is useful for more complex navigation. + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByIntent](remember-navigator-by-intent.md) | | diff --git a/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-key.md b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-key.md new file mode 100644 index 0000000..0628e35 --- /dev/null +++ b/docs/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-key.md @@ -0,0 +1,98 @@ +//[navigation-compose](../../index.md)/[com.chrynan.navigation.compose](index.md)/[rememberNavigatorByKey](remember-navigator-by-key.md) + +# rememberNavigatorByKey + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Key](remember-navigator-by-key.md)> [rememberNavigatorByKey](remember-navigator-by-key.md)(initialKey: [Key](remember-navigator-by-key.md), content: @Composable[ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[Key](remember-navigator-by-key.md)>.([Key](remember-navigator-by-key.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)?, [Key](remember-navigator-by-key.md)> + +Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a key. This allows for specifying the Composable content up front when creating this [ComposeNavigatorByKey](-compose-navigator-by-key/index.md) and simply navigating with a key from the [ComposeNavigatorByKey.goTo](-compose-navigator-by-key/go-to.md) function. + +Example usage: + +val navigator = rememberNavigatorByKey("Greeting") { key ->\ + when(key) {\ + "Greeting" -> Text("Hello")\ + "Farewell" -> Text("Good-bye")\ + else -> Text("Unexpected Key: $key")\ + }\ +}\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello"\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good Bye" after the following call:\ +navigator.goTo("Farewell")\ +\ +// Goes back to the initial content: "Hello":\ +navigator.goBack() + +**Note:** That it is typical to use a [ComposeNavigator](-compose-navigator/index.md) with a [NavContainer](-nav-container.md) to display the Composable content and listen to changes. + +**Note:** This function differs slightly from the [rememberNavigatorByKey](remember-navigator-by-key.md) function in that it only uses a single scope of type [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html). This means that scopes cannot be changed on the returned [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md). + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByKey](remember-navigator-by-key.md) | | + +[common]\ + +@[ExperimentalNavigationApi](-experimental-navigation-api/index.md) + +@Composable + +fun <[Scope](remember-navigator-by-key.md), [Key](remember-navigator-by-key.md)> [rememberNavigatorByKey](remember-navigator-by-key.md)(initialScope: [Scope](remember-navigator-by-key.md), initialKeys: ([Scope](remember-navigator-by-key.md)) -> [Key](remember-navigator-by-key.md), content: @Composable[ComposeNavigationKeyScope](-compose-navigation-key-scope/index.md)<[Key](remember-navigator-by-key.md)>.([Key](remember-navigator-by-key.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [ComposeNavigatorByKeyViewModel](-compose-navigator-by-key-view-model/index.md)<[Scope](remember-navigator-by-key.md), [Key](remember-navigator-by-key.md)> + +Creates and remembers a [ComposeNavigator](-compose-navigator/index.md) that can navigate with a key. This allows for specifying the Composable content up front when creating this [ComposeNavigatorByKey](-compose-navigator-by-key/index.md) and simply navigating with a key from the [ComposeNavigatorByKey.goTo](-compose-navigator-by-key/go-to.md) function. + +Example usage: + +val navigator = rememberNavigatorByKey(\ + initialScope = BottomNavBarItem.HELLO,\ + initialKeys = { scope ->\ + when(scope) {\ + BottomNavBarItem.HELLO -> "Greeting"\ + BottomNavBarItem.GOODBYE -> "Farewell"\ + ...\ + }\ + },\ + content = { key ->\ + when(key) {\ + "Greeting" -> Text("Hello")\ + "Farewell" -> Text("Good-bye")\ + else -> Text("Unexpected Key: $key")\ + }\ + }\ +)\ +\ +// The NavContainer will start by displaying the initial content, which in this case is "Hello"\ +NavContainer(navigator)\ +\ +// The above NavContainer will display "Good Bye" after the following call:\ +navigator.goTo("Farewell")\ +\ +// Goes back to the initial content: "Hello":\ +navigator.goBack()\ +\ +// Changes the scope to BottomNavBarItem.GOODBYE and displays its initial key, which in this case is "Farewell"\ +navigator.changeScope(BottomNavBarItem.GOODBYE) + +**Note:** That it is typical to use a [ComposeNavigator](-compose-navigator/index.md) with a [NavContainer](-nav-container.md) to display the Composable content and listen to changes. + +**Note:** That this function differs slightly from the [rememberNavigatorByKey](remember-navigator-by-key.md) function in that this function allows changing of scopes, which is useful for more complex navigation. + +## See also + +common + +| | | +|---|---| +| [rememberNavigatorByKey](remember-navigator-by-key.md) | | diff --git a/docs/navigation-core/index.md b/docs/navigation-core/index.md new file mode 100644 index 0000000..b2bd06b --- /dev/null +++ b/docs/navigation-core/index.md @@ -0,0 +1,9 @@ +//[navigation-core](index.md) + +# navigation-core + +## Packages + +| Name | +|---| +| [com.chrynan.navigation](navigation-core/com.chrynan.navigation/index.md) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-handler/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-handler/index.md new file mode 100644 index 0000000..2a91b2a --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-handler/index.md @@ -0,0 +1,14 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[AndroidNavigationHandler](index.md) + +# AndroidNavigationHandler + +[android]\ +fun interface [AndroidNavigationHandler](index.md)<[I](index.md) : [NavigationIntent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [NavigationHandler](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md)<[I](index.md), [AndroidNavigationScope](../-android-navigation-scope/index.md)> + +A [NavigationHandler](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md) used on the Android platform that uses an [AndroidNavigationScope](../-android-navigation-scope/index.md). + +## Functions + +| Name | Summary | +|---|---| +| [onNavigate](index.md#1690214574%2FFunctions%2F2082272698) | [android]
abstract fun [AndroidNavigationScope](../-android-navigation-scope/index.md).[onNavigate](index.md#1690214574%2FFunctions%2F2082272698)(event: [NavigationEvent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md)<[I](index.md)>)
Handles the actual navigation to a different part of the app defined by the provided [event](index.md#1690214574%2FFunctions%2F2082272698) using the [S](../../../../navigation-core/com.chrynan.navigation/-navigation-handler/index.md) scope. | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/activity.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/activity.md new file mode 100644 index 0000000..24be334 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/activity.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[AndroidNavigationScope](index.md)/[activity](activity.md) + +# activity + +[android]\ +abstract val [activity](activity.md): [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/index.md new file mode 100644 index 0000000..b6793de --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/index.md @@ -0,0 +1,14 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[AndroidNavigationScope](index.md) + +# AndroidNavigationScope + +[android]\ +interface [AndroidNavigationScope](index.md) : [NavigationScope](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md) + +A [NavigationScope](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md) used on the Android platform that has access to a parent [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) that can be used to change Activities or Fragments. + +## Properties + +| Name | Summary | +|---|---| +| [activity](activity.md) | [android]
abstract val [activity](activity.md): [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-a-d-d_-t-o_-s-t-a-c-k/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-a-d-d_-t-o_-s-t-a-c-k/index.md new file mode 100644 index 0000000..49f4efe --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-a-d-d_-t-o_-s-t-a-c-k/index.md @@ -0,0 +1,13 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavStackDuplicateContentStrategy](../index.md)/[ADD_TO_STACK](index.md) + +# ADD_TO_STACK + +[common]\ +[ADD_TO_STACK](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../-c-l-e-a-r_-s-t-a-c-k/index.md#-372974862%2FProperties%2F-215881696) | [common]
val [name](../-c-l-e-a-r_-s-t-a-c-k/index.md#-372974862%2FProperties%2F-215881696): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-c-l-e-a-r_-s-t-a-c-k/index.md#-739389684%2FProperties%2F-215881696) | [common]
val [ordinal](../-c-l-e-a-r_-s-t-a-c-k/index.md#-739389684%2FProperties%2F-215881696): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-c-l-e-a-r_-s-t-a-c-k/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-c-l-e-a-r_-s-t-a-c-k/index.md new file mode 100644 index 0000000..3e64365 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-c-l-e-a-r_-s-t-a-c-k/index.md @@ -0,0 +1,13 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavStackDuplicateContentStrategy](../index.md)/[CLEAR_STACK](index.md) + +# CLEAR_STACK + +[common]\ +[CLEAR_STACK](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](index.md#-372974862%2FProperties%2F-215881696) | [common]
val [name](index.md#-372974862%2FProperties%2F-215881696): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](index.md#-739389684%2FProperties%2F-215881696) | [common]
val [ordinal](index.md#-739389684%2FProperties%2F-215881696): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-companion/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-companion/index.md new file mode 100644 index 0000000..9b64f94 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavStackDuplicateContentStrategy](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md new file mode 100644 index 0000000..57b3d47 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md @@ -0,0 +1,26 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavStackDuplicateContentStrategy](index.md) + +# NavStackDuplicateContentStrategy + +[common]\ +enum [NavStackDuplicateContentStrategy](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NavStackDuplicateContentStrategy](index.md)> + +## Entries + +| | | +|---|---| +| [ADD_TO_STACK](-a-d-d_-t-o_-s-t-a-c-k/index.md) | [common]
[ADD_TO_STACK](-a-d-d_-t-o_-s-t-a-c-k/index.md)() | +| [CLEAR_STACK](-c-l-e-a-r_-s-t-a-c-k/index.md) | [common]
[CLEAR_STACK](-c-l-e-a-r_-s-t-a-c-k/index.md)() | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [name](-c-l-e-a-r_-s-t-a-c-k/index.md#-372974862%2FProperties%2F-215881696) | [common]
val [name](-c-l-e-a-r_-s-t-a-c-k/index.md#-372974862%2FProperties%2F-215881696): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](-c-l-e-a-r_-s-t-a-c-k/index.md#-739389684%2FProperties%2F-215881696) | [common]
val [ordinal](-c-l-e-a-r_-s-t-a-c-k/index.md#-739389684%2FProperties%2F-215881696): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/-companion/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/-companion/index.md new file mode 100644 index 0000000..0349cb8 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEventHandler](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/index.md new file mode 100644 index 0000000..db0bef0 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/index.md @@ -0,0 +1,23 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEventHandler](index.md) + +# NavigationEventHandler + +[common]\ +interface [NavigationEventHandler](index.md)<[I](index.md) : [NavigationIntent](../-navigation-intent/index.md), [S](index.md) : [NavigationScope](../-navigation-scope/index.md)> : [NavigationHandler](../-navigation-handler/index.md)<[I](index.md), [S](index.md)> + +A [NavigationHandler](../-navigation-handler/index.md) that provides distinct functions for each of the possible [NavigationEvent](../-navigation-event/index.md)s. + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [onGoBack](on-go-back.md) | [common]
abstract fun [S](index.md).[onGoBack](on-go-back.md)() | +| [onGoTo](on-go-to.md) | [common]
abstract fun [S](index.md).[onGoTo](on-go-to.md)(intent: [I](index.md)) | +| [onGoUp](on-go-up.md) | [common]
abstract fun [S](index.md).[onGoUp](on-go-up.md)() | +| [onNavigate](on-navigate.md) | [common]
open override fun [S](index.md).[onNavigate](on-navigate.md)(event: [NavigationEvent](../-navigation-event/index.md)<[I](index.md)>)
Handles the actual navigation to a different part of the app defined by the provided [event](on-navigate.md) using the [S](index.md) scope. | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-back.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-back.md new file mode 100644 index 0000000..68dfc0d --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-back.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEventHandler](index.md)/[onGoBack](on-go-back.md) + +# onGoBack + +[common]\ +abstract fun [S](index.md).[onGoBack](on-go-back.md)() diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-to.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-to.md new file mode 100644 index 0000000..7e7025e --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-to.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEventHandler](index.md)/[onGoTo](on-go-to.md) + +# onGoTo + +[common]\ +abstract fun [S](index.md).[onGoTo](on-go-to.md)(intent: [I](index.md)) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-up.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-up.md new file mode 100644 index 0000000..ee5426c --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-up.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEventHandler](index.md)/[onGoUp](on-go-up.md) + +# onGoUp + +[common]\ +abstract fun [S](index.md).[onGoUp](on-go-up.md)() diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-navigate.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-navigate.md new file mode 100644 index 0000000..80cf5f8 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-navigate.md @@ -0,0 +1,8 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEventHandler](index.md)/[onNavigate](on-navigate.md) + +# onNavigate + +[common]\ +open override fun [S](index.md).[onNavigate](on-navigate.md)(event: [NavigationEvent](../-navigation-event/index.md)<[I](index.md)>) + +Handles the actual navigation to a different part of the app defined by the provided [event](on-navigate.md) using the [S](index.md) scope. diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md new file mode 100644 index 0000000..1f23704 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md @@ -0,0 +1,22 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEventNavigator](index.md) + +# NavigationEventNavigator + +[common]\ +interface [NavigationEventNavigator](index.md)<[I](index.md) : [NavigationIntent](../-navigation-intent/index.md)> : [Navigator](../-navigator/index.md) + +A [Navigator](../-navigator/index.md) that navigates using [NavigationEvent](../-navigation-event/index.md)s. This is typically the base [Navigator](../-navigator/index.md) but not every UI framework can use it, such as Jetpack Compose, so it is separate from the [Navigator](../-navigator/index.md) interface. + +## Functions + +| Name | Summary | +|---|---| +| [navigate](navigate.md) | [common]
abstract fun [navigate](navigate.md)(event: [NavigationEvent](../-navigation-event/index.md)<[I](index.md)>)
Navigates to the provided [event](navigate.md). | + +## Extensions + +| Name | Summary | +|---|---| +| [goBack](../go-back.md) | [common]
fun <[I](../go-back.md) : [NavigationIntent](../-navigation-intent/index.md)> [NavigationEventNavigator](index.md)<[I](../go-back.md)>.[goBack](../go-back.md)()
A convenience function for calling [NavigationEventNavigator.navigate](navigate.md) with [NavigationEvent.Back](../-navigation-event/-back/index.md). | +| [goTo](../go-to.md) | [common]
fun <[I](../go-to.md) : [NavigationIntent](../-navigation-intent/index.md)> [NavigationEventNavigator](index.md)<[I](../go-to.md)>.[goTo](../go-to.md)(intent: [I](../go-to.md))
A convenience function for calling [NavigationEventNavigator.navigate](navigate.md) with [NavigationEvent.To](../-navigation-event/-to/index.md). | +| [goUp](../go-up.md) | [common]
fun <[I](../go-up.md) : [NavigationIntent](../-navigation-intent/index.md)> [NavigationEventNavigator](index.md)<[I](../go-up.md)>.[goUp](../go-up.md)()
A convenience function for calling [NavigationEventNavigator.navigate](navigate.md) with [NavigationEvent.Up](../-navigation-event/-up/index.md). | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/navigate.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/navigate.md new file mode 100644 index 0000000..178b551 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/navigate.md @@ -0,0 +1,8 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEventNavigator](index.md)/[navigate](navigate.md) + +# navigate + +[common]\ +abstract fun [navigate](navigate.md)(event: [NavigationEvent](../-navigation-event/index.md)<[I](index.md)>) + +Navigates to the provided [event](navigate.md). diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/-back.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/-back.md new file mode 100644 index 0000000..7aa71f8 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/-back.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[Back](index.md)/[Back](-back.md) + +# Back + +[common]\ +fun [Back](-back.md)() diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/index.md new file mode 100644 index 0000000..86133c8 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[Back](index.md) + +# Back + +[common]\ +class [Back](index.md)<[I](index.md) : [NavigationIntent](../../-navigation-intent/index.md)> : [NavigationEvent](../index.md)<[I](index.md)> diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-companion/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-companion/index.md new file mode 100644 index 0000000..c408218 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/-to.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/-to.md new file mode 100644 index 0000000..5603587 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/-to.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[To](index.md)/[To](-to.md) + +# To + +[common]\ +fun <[I](index.md) : [NavigationIntent](../../-navigation-intent/index.md)> [To](-to.md)(intent: [I](index.md)) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/index.md new file mode 100644 index 0000000..2b2c08d --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/index.md @@ -0,0 +1,12 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[To](index.md) + +# To + +[common]\ +data class [To](index.md)<[I](index.md) : [NavigationIntent](../../-navigation-intent/index.md)>(intent: [I](index.md)) : [NavigationEvent](../index.md)<[I](index.md)> + +## Properties + +| Name | Summary | +|---|---| +| [intent](intent.md) | [common]
val [intent](intent.md): [I](index.md) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/intent.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/intent.md new file mode 100644 index 0000000..d8fc460 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/intent.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[To](index.md)/[intent](intent.md) + +# intent + +[common]\ +val [intent](intent.md): [I](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/-up.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/-up.md new file mode 100644 index 0000000..84b749b --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/-up.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[Up](index.md)/[Up](-up.md) + +# Up + +[common]\ +fun [Up](-up.md)() diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/index.md new file mode 100644 index 0000000..56a1630 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationEvent](../index.md)/[Up](index.md) + +# Up + +[common]\ +class [Up](index.md)<[I](index.md) : [NavigationIntent](../../-navigation-intent/index.md)> : [NavigationEvent](../index.md)<[I](index.md)> diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md new file mode 100644 index 0000000..e6548a6 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md @@ -0,0 +1,34 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationEvent](index.md) + +# NavigationEvent + +[common]\ +sealed class [NavigationEvent](index.md)<[I](index.md) : [NavigationIntent](../-navigation-intent/index.md)> + +An event that is sent to a [Navigator](../-navigator/index.md) to coordinate the navigation between screens. + +## See also + +common + +| | | +|---|---| +| Navigator.navigate | | +| [com.chrynan.navigation.NavigationHandler](../-navigation-handler/on-navigate.md) | | + +## Types + +| Name | Summary | +|---|---| +| [Back](-back/index.md) | [common]
class [Back](-back/index.md)<[I](-back/index.md) : [NavigationIntent](../-navigation-intent/index.md)> : [NavigationEvent](index.md)<[I](-back/index.md)> | +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | +| [To](-to/index.md) | [common]
data class [To](-to/index.md)<[I](-to/index.md) : [NavigationIntent](../-navigation-intent/index.md)>(intent: [I](-to/index.md)) : [NavigationEvent](index.md)<[I](-to/index.md)> | +| [Up](-up/index.md) | [common]
class [Up](-up/index.md)<[I](-up/index.md) : [NavigationIntent](../-navigation-intent/index.md)> : [NavigationEvent](index.md)<[I](-up/index.md)> | + +## Inheritors + +| Name | +|---| +| [NavigationEvent](-back/index.md) | +| [NavigationEvent](-up/index.md) | +| [NavigationEvent](-to/index.md) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/-companion/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/-companion/index.md new file mode 100644 index 0000000..6912a79 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationHandler](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md new file mode 100644 index 0000000..109522b --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md @@ -0,0 +1,27 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationHandler](index.md) + +# NavigationHandler + +[common]\ +fun interface [NavigationHandler](index.md)<[I](index.md) : [NavigationIntent](../-navigation-intent/index.md), [S](index.md) : [NavigationScope](../-navigation-scope/index.md)> + +Handles the navigation from a [Navigator](../-navigator/index.md). + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [onNavigate](on-navigate.md) | [common]
abstract fun [S](index.md).[onNavigate](on-navigate.md)(event: [NavigationEvent](../-navigation-event/index.md)<[I](index.md)>)
Handles the actual navigation to a different part of the app defined by the provided [event](on-navigate.md) using the [S](index.md) scope. | + +## Inheritors + +| Name | +|---| +| [AndroidNavigationHandler](../-android-navigation-handler/index.md) | +| [NavigationEventHandler](../-navigation-event-handler/index.md) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/on-navigate.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/on-navigate.md new file mode 100644 index 0000000..ee6706c --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/on-navigate.md @@ -0,0 +1,8 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationHandler](index.md)/[onNavigate](on-navigate.md) + +# onNavigate + +[common]\ +abstract fun [S](index.md).[onNavigate](on-navigate.md)(event: [NavigationEvent](../-navigation-event/index.md)<[I](index.md)>) + +Handles the actual navigation to a different part of the app defined by the provided [event](on-navigate.md) using the [S](index.md) scope. diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/-companion/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/-companion/index.md new file mode 100644 index 0000000..54aa467 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationIntent](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md new file mode 100644 index 0000000..6c8b325 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md @@ -0,0 +1,21 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationIntent](index.md) + +# NavigationIntent + +[common]\ +interface [NavigationIntent](index.md) + +Represents an intent to move to a different screen in the application. This is similar to an Intent but for navigation purposes. + +For example: + +sealed class HomeScreenIntent : NavigationIntent {\ +\ + object Feed : HomeScreenIntent()\ +} + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/-companion/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/-companion/index.md new file mode 100644 index 0000000..b480b03 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[NavigationScope](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md new file mode 100644 index 0000000..1f19ad7 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md @@ -0,0 +1,20 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[NavigationScope](index.md) + +# NavigationScope + +[common]\ +interface [NavigationScope](index.md) + +Provides the ability for extra platform specific parameters to be provided to a [Navigator](../-navigator/index.md). + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Inheritors + +| Name | +|---| +| [AndroidNavigationScope](../-android-navigation-scope/index.md) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigator/-companion/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigator/-companion/index.md new file mode 100644 index 0000000..0fa7e94 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigator/-companion/index.md @@ -0,0 +1,6 @@ +//[navigation-core](../../../../index.md)/[com.chrynan.navigation](../../index.md)/[Navigator](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md new file mode 100644 index 0000000..061eae5 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md @@ -0,0 +1,22 @@ +//[navigation-core](../../../index.md)/[com.chrynan.navigation](../index.md)/[Navigator](index.md) + +# Navigator + +[common]\ +interface [Navigator](index.md) + +A [Navigator](index.md) is responsible for changing and showing the different Screens in the application. + +A [Navigator](index.md) is platform and UI framework dependent, so each implementation depends on the particular UI framework used, for example, Jetpack Compose. + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Inheritors + +| Name | +|---| +| [NavigationEventNavigator](../-navigation-event-navigator/index.md) | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/go-back.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/go-back.md new file mode 100644 index 0000000..743bfcf --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/go-back.md @@ -0,0 +1,8 @@ +//[navigation-core](../../index.md)/[com.chrynan.navigation](index.md)/[goBack](go-back.md) + +# goBack + +[common]\ +fun <[I](go-back.md) : [NavigationIntent](-navigation-intent/index.md)> [NavigationEventNavigator](-navigation-event-navigator/index.md)<[I](go-back.md)>.[goBack](go-back.md)() + +A convenience function for calling [NavigationEventNavigator.navigate](-navigation-event-navigator/navigate.md) with [NavigationEvent.Back](-navigation-event/-back/index.md). diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/go-to.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/go-to.md new file mode 100644 index 0000000..f6c5649 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/go-to.md @@ -0,0 +1,8 @@ +//[navigation-core](../../index.md)/[com.chrynan.navigation](index.md)/[goTo](go-to.md) + +# goTo + +[common]\ +fun <[I](go-to.md) : [NavigationIntent](-navigation-intent/index.md)> [NavigationEventNavigator](-navigation-event-navigator/index.md)<[I](go-to.md)>.[goTo](go-to.md)(intent: [I](go-to.md)) + +A convenience function for calling [NavigationEventNavigator.navigate](-navigation-event-navigator/navigate.md) with [NavigationEvent.To](-navigation-event/-to/index.md). diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/go-up.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/go-up.md new file mode 100644 index 0000000..1b83dae --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/go-up.md @@ -0,0 +1,8 @@ +//[navigation-core](../../index.md)/[com.chrynan.navigation](index.md)/[goUp](go-up.md) + +# goUp + +[common]\ +fun <[I](go-up.md) : [NavigationIntent](-navigation-intent/index.md)> [NavigationEventNavigator](-navigation-event-navigator/index.md)<[I](go-up.md)>.[goUp](go-up.md)() + +A convenience function for calling [NavigationEventNavigator.navigate](-navigation-event-navigator/navigate.md) with [NavigationEvent.Up](-navigation-event/-up/index.md). diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/index.md new file mode 100644 index 0000000..bc92361 --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/index.md @@ -0,0 +1,27 @@ +//[navigation-core](../../index.md)/[com.chrynan.navigation](index.md) + +# Package com.chrynan.navigation + +## Types + +| Name | Summary | +|---|---| +| [AndroidNavigationHandler](-android-navigation-handler/index.md) | [android]
fun interface [AndroidNavigationHandler](-android-navigation-handler/index.md)<[I](-android-navigation-handler/index.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> : [NavigationHandler](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md)<[I](-android-navigation-handler/index.md), [AndroidNavigationScope](-android-navigation-scope/index.md)>
A [NavigationHandler](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md) used on the Android platform that uses an [AndroidNavigationScope](-android-navigation-scope/index.md). | +| [AndroidNavigationScope](-android-navigation-scope/index.md) | [android]
interface [AndroidNavigationScope](-android-navigation-scope/index.md) : [NavigationScope](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md)
A [NavigationScope](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md) used on the Android platform that has access to a parent [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) that can be used to change Activities or Fragments. | +| [NavigationEvent](-navigation-event/index.md) | [common]
sealed class [NavigationEvent](-navigation-event/index.md)<[I](-navigation-event/index.md) : [NavigationIntent](-navigation-intent/index.md)>
An event that is sent to a [Navigator](-navigator/index.md) to coordinate the navigation between screens. | +| [NavigationEventHandler](-navigation-event-handler/index.md) | [common]
interface [NavigationEventHandler](-navigation-event-handler/index.md)<[I](-navigation-event-handler/index.md) : [NavigationIntent](-navigation-intent/index.md), [S](-navigation-event-handler/index.md) : [NavigationScope](-navigation-scope/index.md)> : [NavigationHandler](-navigation-handler/index.md)<[I](-navigation-event-handler/index.md), [S](-navigation-event-handler/index.md)>
A [NavigationHandler](-navigation-handler/index.md) that provides distinct functions for each of the possible [NavigationEvent](-navigation-event/index.md)s. | +| [NavigationEventNavigator](-navigation-event-navigator/index.md) | [common]
interface [NavigationEventNavigator](-navigation-event-navigator/index.md)<[I](-navigation-event-navigator/index.md) : [NavigationIntent](-navigation-intent/index.md)> : [Navigator](-navigator/index.md)
A [Navigator](-navigator/index.md) that navigates using [NavigationEvent](-navigation-event/index.md)s. This is typically the base [Navigator](-navigator/index.md) but not every UI framework can use it, such as Jetpack Compose, so it is separate from the [Navigator](-navigator/index.md) interface. | +| [NavigationHandler](-navigation-handler/index.md) | [common]
fun interface [NavigationHandler](-navigation-handler/index.md)<[I](-navigation-handler/index.md) : [NavigationIntent](-navigation-intent/index.md), [S](-navigation-handler/index.md) : [NavigationScope](-navigation-scope/index.md)>
Handles the navigation from a [Navigator](-navigator/index.md). | +| [NavigationIntent](-navigation-intent/index.md) | [common]
interface [NavigationIntent](-navigation-intent/index.md)
Represents an intent to move to a different screen in the application. This is similar to an Intent but for navigation purposes. | +| [NavigationScope](-navigation-scope/index.md) | [common]
interface [NavigationScope](-navigation-scope/index.md)
Provides the ability for extra platform specific parameters to be provided to a [Navigator](-navigator/index.md). | +| [Navigator](-navigator/index.md) | [common]
interface [Navigator](-navigator/index.md)
A [Navigator](-navigator/index.md) is responsible for changing and showing the different Screens in the application. | +| [NavStackDuplicateContentStrategy](-nav-stack-duplicate-content-strategy/index.md) | [common]
enum [NavStackDuplicateContentStrategy](-nav-stack-duplicate-content-strategy/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NavStackDuplicateContentStrategy](-nav-stack-duplicate-content-strategy/index.md)> | + +## Functions + +| Name | Summary | +|---|---| +| [goBack](go-back.md) | [common]
fun <[I](go-back.md) : [NavigationIntent](-navigation-intent/index.md)> [NavigationEventNavigator](-navigation-event-navigator/index.md)<[I](go-back.md)>.[goBack](go-back.md)()
A convenience function for calling [NavigationEventNavigator.navigate](-navigation-event-navigator/navigate.md) with [NavigationEvent.Back](-navigation-event/-back/index.md). | +| [goTo](go-to.md) | [common]
fun <[I](go-to.md) : [NavigationIntent](-navigation-intent/index.md)> [NavigationEventNavigator](-navigation-event-navigator/index.md)<[I](go-to.md)>.[goTo](go-to.md)(intent: [I](go-to.md))
A convenience function for calling [NavigationEventNavigator.navigate](-navigation-event-navigator/navigate.md) with [NavigationEvent.To](-navigation-event/-to/index.md). | +| [goUp](go-up.md) | [common]
fun <[I](go-up.md) : [NavigationIntent](-navigation-intent/index.md)> [NavigationEventNavigator](-navigation-event-navigator/index.md)<[I](go-up.md)>.[goUp](go-up.md)()
A convenience function for calling [NavigationEventNavigator.navigate](-navigation-event-navigator/navigate.md) with [NavigationEvent.Up](-navigation-event/-up/index.md). | +| [navigator](navigator.md) | [android]
fun <[I](navigator.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [navigator](navigator.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), handler: [AndroidNavigationHandler](-android-navigation-handler/index.md)<[I](navigator.md)>): [NavigationEventNavigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md)<[I](navigator.md)>
Creates a [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) using the provided [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) in the [AndroidNavigationScope](-android-navigation-scope/index.md) and the provided [handler](navigator.md).
[android]
fun <[I](navigator.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [navigator](navigator.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), onGoBack: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) = { activity.onBackPressed() }, onGoUp: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) = { activity.onBackPressed() }, onGoTo: ([I](navigator.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [NavigationEventNavigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md)<[I](navigator.md)>
Creates a [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) using the provided [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) in the [AndroidNavigationScope](-android-navigation-scope/index.md) and the provided [onGoBack](navigator.md), [onGoUp](navigator.md), and [onGoTo](navigator.md) functions to construct an [AndroidNavigationHandler](-android-navigation-handler/index.md). | diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/navigator.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/navigator.md new file mode 100644 index 0000000..4afffea --- /dev/null +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/navigator.md @@ -0,0 +1,33 @@ +//[navigation-core](../../index.md)/[com.chrynan.navigation](index.md)/[navigator](navigator.md) + +# navigator + +[android]\ +fun <[I](navigator.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [navigator](navigator.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), handler: [AndroidNavigationHandler](-android-navigation-handler/index.md)<[I](navigator.md)>): [NavigationEventNavigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md)<[I](navigator.md)> + +Creates a [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) using the provided [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) in the [AndroidNavigationScope](-android-navigation-scope/index.md) and the provided [handler](navigator.md). + +Example usage: + +val navigator = navigator(activity, AndroidNavigationHandler { event ->\ + when (event) {\ + is NavigationEvent.Back -> activity.onBackPressed()\ + is NavigationEvent.Up -> activity.onBackPressed()\ + is NavigationEvent.To -> { ... }\ + }\ +})\ +\ +navigator.goBack() + +[android]\ +fun <[I](navigator.md) : [NavigationIntent](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)> [navigator](navigator.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), onGoBack: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) = { activity.onBackPressed() }, onGoUp: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) = { activity.onBackPressed() }, onGoTo: ([I](navigator.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [NavigationEventNavigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md)<[I](navigator.md)> + +Creates a [Navigator](../../../navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md) using the provided [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) in the [AndroidNavigationScope](-android-navigation-scope/index.md) and the provided [onGoBack](navigator.md), [onGoUp](navigator.md), and [onGoTo](navigator.md) functions to construct an [AndroidNavigationHandler](-android-navigation-handler/index.md). + +Example usage: + +val navigator = navigator<NavigationIntent>(activity = activity, onGoTo = { navigationIntent ->\ + activity.startActivity(...)\ +})\ +\ +navigator.goBack() diff --git a/docs/package-list b/docs/package-list new file mode 100644 index 0000000..873b1e8 --- /dev/null +++ b/docs/package-list @@ -0,0 +1,138 @@ +$dokka.format:gfm-v1 +$dokka.linkExtension:md +$dokka.location:com.chrynan.navigation.compose////PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/index.md +$dokka.location:com.chrynan.navigation.compose//NavContainer/#com.chrynan.navigation.compose.ComposeNavigationIntentNavigatorByKeyViewModel[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-container.md +$dokka.location:com.chrynan.navigation.compose//NavContainer/#com.chrynan.navigation.compose.ComposeNavigatorByContentViewModel[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-container.md +$dokka.location:com.chrynan.navigation.compose//NavContainer/#com.chrynan.navigation.compose.ComposeNavigatorByKeyViewModel[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-container.md +$dokka.location:com.chrynan.navigation.compose//currentKeyAsState/com.chrynan.navigation.compose.ComposeNavigator[TypeParam(bounds=[kotlin.Any?])]#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-key-as-state.md +$dokka.location:com.chrynan.navigation.compose//currentKeyAsState/com.chrynan.navigation.compose.ComposeNavigator[TypeParam(bounds=[kotlin.Any?])]#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-key-as-state.md +$dokka.location:com.chrynan.navigation.compose//currentScopeAsState/com.chrynan.navigation.compose.ComposeScopedNavigator[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-scope-as-state.md +$dokka.location:com.chrynan.navigation.compose//currentScopeAsState/com.chrynan.navigation.compose.ComposeScopedNavigator[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/current-scope-as-state.md +$dokka.location:com.chrynan.navigation.compose//goTo/com.chrynan.navigation.compose.ComposeNavigatorByContent[TypeParam(bounds=[kotlin.Any?])]#TypeParam(bounds=[kotlin.Any?])#kotlin.Function1[com.chrynan.navigation.compose.ComposeNavigationContentScope[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/go-to.md +$dokka.location:com.chrynan.navigation.compose//goTo/com.chrynan.navigation.compose.ComposeNavigatorByKey[TypeParam(bounds=[kotlin.Any?])]#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/go-to.md +$dokka.location:com.chrynan.navigation.compose//rememberNavigatorByContent/#TypeParam(bounds=[kotlin.Any?])#kotlin.Function1[TypeParam(bounds=[kotlin.Any?]),kotlin.Pair[TypeParam(bounds=[kotlin.Any?]),kotlin.Function1[com.chrynan.navigation.compose.ComposeNavigationContentScope[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]]]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-content.md +$dokka.location:com.chrynan.navigation.compose//rememberNavigatorByContent/#TypeParam(bounds=[kotlin.Any?])#kotlin.Function1[com.chrynan.navigation.compose.ComposeNavigationContentScope[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-content.md +$dokka.location:com.chrynan.navigation.compose//rememberNavigatorByIntent/#TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])#kotlin.Function2[com.chrynan.navigation.compose.ComposeNavigationIntentScope[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])],TypeParam(bounds=[com.chrynan.navigation.NavigationIntent]),kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-intent.md +$dokka.location:com.chrynan.navigation.compose//rememberNavigatorByIntent/#TypeParam(bounds=[kotlin.Any?])#kotlin.Function1[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]#kotlin.Function2[com.chrynan.navigation.compose.ComposeNavigationIntentScope[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])],TypeParam(bounds=[com.chrynan.navigation.NavigationIntent]),kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-intent.md +$dokka.location:com.chrynan.navigation.compose//rememberNavigatorByKey/#TypeParam(bounds=[kotlin.Any?])#kotlin.Function1[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]#kotlin.Function2[com.chrynan.navigation.compose.ComposeNavigationKeyScope[TypeParam(bounds=[kotlin.Any?])],TypeParam(bounds=[kotlin.Any?]),kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-key.md +$dokka.location:com.chrynan.navigation.compose//rememberNavigatorByKey/#TypeParam(bounds=[kotlin.Any?])#kotlin.Function2[com.chrynan.navigation.compose.ComposeNavigationKeyScope[TypeParam(bounds=[kotlin.Any?])],TypeParam(bounds=[kotlin.Any?]),kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/remember-navigator-by-key.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByContentViewModel///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/index.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByContentViewModel/BaseComposeNavigatorByContentViewModel/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-content-view-model/-base-compose-navigator-by-content-view-model.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/index.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/BaseComposeNavigatorByKeyViewModel/#TypeParam(bounds=[kotlin.Any?])#kotlin.Function1[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/-base-compose-navigator-by-key-view-model.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/canGoBack/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/can-go-back.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/changeScope/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/change-scope.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/currentKey/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-key.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/currentScope/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/current-scope.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/goBack/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-back.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/goTo/#TypeParam(bounds=[kotlin.Any?])#com.chrynan.navigation.NavStackDuplicateContentStrategy/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/go-to.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/initialKey/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-key.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/initialScope/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/initial-scope.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/isInitialized/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/is-initialized.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/keyChanges/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/key-changes.md +$dokka.location:com.chrynan.navigation.compose/BaseComposeNavigatorByKeyViewModel/scopeChanges/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-base-compose-navigator-by-key-view-model/scope-changes.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationContentScope.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationContentScope///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationContentScope/navigator/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-content-scope/navigator.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentNavigatorByKeyViewModel///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-navigator-by-key-view-model/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentScope.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentScope///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentScope/navigator/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-scope/navigator.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentStackNavigatorByKey///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentStackNavigatorByKey/navigate/#com.chrynan.navigation.NavigationEvent[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/navigate.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentStackNavigatorByKey/onGoBack/com.chrynan.navigation.compose.ComposeNavigationIntentScope[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-back.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentStackNavigatorByKey/onGoTo/com.chrynan.navigation.compose.ComposeNavigationIntentScope[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]#TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-to.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationIntentStackNavigatorByKey/onGoUp/com.chrynan.navigation.compose.ComposeNavigationIntentScope[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-intent-stack-navigator-by-key/on-go-up.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationKeyScope.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationKeyScope///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationKeyScope/navigator/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-key-scope/navigator.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationScope.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigationScope///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigation-scope/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigator.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigator///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigator/currentKey/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/current-key.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigator/initialKey/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/initial-key.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigator/isInitialized/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/is-initialized.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigator/keyChanges/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator/key-changes.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContent.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContent///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContent/goTo/#TypeParam(bounds=[kotlin.Any?])#com.chrynan.navigation.NavStackDuplicateContentStrategy#kotlin.Function1[com.chrynan.navigation.compose.ComposeNavigationContentScope[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content/go-to.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/canGoBack/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/can-go-back.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/changeScope/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/change-scope.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/currentKey/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-key.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/currentScope/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/current-scope.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/goBack/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-back.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/goTo/#TypeParam(bounds=[kotlin.Any?])#com.chrynan.navigation.NavStackDuplicateContentStrategy#kotlin.Function1[com.chrynan.navigation.compose.ComposeNavigationContentScope[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/go-to.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/initialKey/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-key.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/initialScope/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/initial-scope.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/isInitialized/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/is-initialized.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/keyChanges/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/key-changes.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByContentViewModel/scopeChanges/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-content-view-model/scope-changes.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByKey.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByKey///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByKey/goTo/#TypeParam(bounds=[kotlin.Any?])#com.chrynan.navigation.NavStackDuplicateContentStrategy/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key/go-to.md +$dokka.location:com.chrynan.navigation.compose/ComposeNavigatorByKeyViewModel///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-navigator-by-key-view-model/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeScopedNavigator.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeScopedNavigator///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeScopedNavigator/changeScope/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/change-scope.md +$dokka.location:com.chrynan.navigation.compose/ComposeScopedNavigator/currentScope/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/current-scope.md +$dokka.location:com.chrynan.navigation.compose/ComposeScopedNavigator/initialScope/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/initial-scope.md +$dokka.location:com.chrynan.navigation.compose/ComposeScopedNavigator/scopeChanges/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-scoped-navigator/scope-changes.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigator.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigator///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigator/canGoBack/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/can-go-back.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigator/goBack/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator/go-back.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigatorByContent.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigatorByContent///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-content/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigatorByKey.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/ComposeStackNavigatorByKey///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-compose-stack-navigator-by-key/index.md +$dokka.location:com.chrynan.navigation.compose/ExperimentalNavigationApi///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/index.md +$dokka.location:com.chrynan.navigation.compose/ExperimentalNavigationApi/ExperimentalNavigationApi/#/PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-experimental-navigation-api/-experimental-navigation-api.md +$dokka.location:com.chrynan.navigation.compose/NavBackStrategy.Companion///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-companion/index.md +$dokka.location:com.chrynan.navigation.compose/NavBackStrategy.EVENT///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-e-v-e-n-t/index.md +$dokka.location:com.chrynan.navigation.compose/NavBackStrategy.STACK///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/-s-t-a-c-k/index.md +$dokka.location:com.chrynan.navigation.compose/NavBackStrategy///PointingToDeclaration/navigation-compose/navigation-compose/com.chrynan.navigation.compose/-nav-back-strategy/index.md +$dokka.location:com.chrynan.navigation////PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/index.md +$dokka.location:com.chrynan.navigation//goBack/com.chrynan.navigation.NavigationEventNavigator[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/go-back.md +$dokka.location:com.chrynan.navigation//goTo/com.chrynan.navigation.NavigationEventNavigator[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]#TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/go-to.md +$dokka.location:com.chrynan.navigation//goUp/com.chrynan.navigation.NavigationEventNavigator[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/go-up.md +$dokka.location:com.chrynan.navigation//navigator/#android.app.Activity#com.chrynan.navigation.AndroidNavigationHandler[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/navigator.md +$dokka.location:com.chrynan.navigation//navigator/#android.app.Activity#kotlin.Function0[kotlin.Unit]#kotlin.Function0[kotlin.Unit]#kotlin.Function1[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent]),kotlin.Unit]/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/navigator.md +$dokka.location:com.chrynan.navigation/AndroidNavigationHandler///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-handler/index.md +$dokka.location:com.chrynan.navigation/AndroidNavigationScope///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/index.md +$dokka.location:com.chrynan.navigation/AndroidNavigationScope/activity/#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-android-navigation-scope/activity.md +$dokka.location:com.chrynan.navigation/NavStackDuplicateContentStrategy.ADD_TO_STACK///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-a-d-d_-t-o_-s-t-a-c-k/index.md +$dokka.location:com.chrynan.navigation/NavStackDuplicateContentStrategy.CLEAR_STACK///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-c-l-e-a-r_-s-t-a-c-k/index.md +$dokka.location:com.chrynan.navigation/NavStackDuplicateContentStrategy.Companion///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/-companion/index.md +$dokka.location:com.chrynan.navigation/NavStackDuplicateContentStrategy///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-nav-stack-duplicate-content-strategy/index.md +$dokka.location:com.chrynan.navigation/NavigationEvent.Back///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/index.md +$dokka.location:com.chrynan.navigation/NavigationEvent.Back/Back/#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-back/-back.md +$dokka.location:com.chrynan.navigation/NavigationEvent.Companion///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-companion/index.md +$dokka.location:com.chrynan.navigation/NavigationEvent.To///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/index.md +$dokka.location:com.chrynan.navigation/NavigationEvent.To/To/#TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/-to.md +$dokka.location:com.chrynan.navigation/NavigationEvent.To/intent/#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-to/intent.md +$dokka.location:com.chrynan.navigation/NavigationEvent.Up///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/index.md +$dokka.location:com.chrynan.navigation/NavigationEvent.Up/Up/#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/-up/-up.md +$dokka.location:com.chrynan.navigation/NavigationEvent///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md +$dokka.location:com.chrynan.navigation/NavigationEventHandler.Companion///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/-companion/index.md +$dokka.location:com.chrynan.navigation/NavigationEventHandler///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/index.md +$dokka.location:com.chrynan.navigation/NavigationEventHandler/onGoBack/TypeParam(bounds=[com.chrynan.navigation.NavigationScope])#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-back.md +$dokka.location:com.chrynan.navigation/NavigationEventHandler/onGoTo/TypeParam(bounds=[com.chrynan.navigation.NavigationScope])#TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-to.md +$dokka.location:com.chrynan.navigation/NavigationEventHandler/onGoUp/TypeParam(bounds=[com.chrynan.navigation.NavigationScope])#/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-go-up.md +$dokka.location:com.chrynan.navigation/NavigationEventHandler/onNavigate/TypeParam(bounds=[com.chrynan.navigation.NavigationScope])#com.chrynan.navigation.NavigationEvent[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-handler/on-navigate.md +$dokka.location:com.chrynan.navigation/NavigationEventNavigator///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/index.md +$dokka.location:com.chrynan.navigation/NavigationEventNavigator/navigate/#com.chrynan.navigation.NavigationEvent[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-event-navigator/navigate.md +$dokka.location:com.chrynan.navigation/NavigationHandler.Companion///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/-companion/index.md +$dokka.location:com.chrynan.navigation/NavigationHandler///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/index.md +$dokka.location:com.chrynan.navigation/NavigationHandler/onNavigate/TypeParam(bounds=[com.chrynan.navigation.NavigationScope])#com.chrynan.navigation.NavigationEvent[TypeParam(bounds=[com.chrynan.navigation.NavigationIntent])]/PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-handler/on-navigate.md +$dokka.location:com.chrynan.navigation/NavigationIntent.Companion///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/-companion/index.md +$dokka.location:com.chrynan.navigation/NavigationIntent///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md +$dokka.location:com.chrynan.navigation/NavigationScope.Companion///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/-companion/index.md +$dokka.location:com.chrynan.navigation/NavigationScope///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigation-scope/index.md +$dokka.location:com.chrynan.navigation/Navigator.Companion///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigator/-companion/index.md +$dokka.location:com.chrynan.navigation/Navigator///PointingToDeclaration/navigation-core/navigation-core/com.chrynan.navigation/-navigator/index.md +module:navigation-compose +com.chrynan.navigation.compose +module:navigation-core +com.chrynan.navigation