Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed Jan 1, 2022
1 parent 828e2c9 commit 96215be
Show file tree
Hide file tree
Showing 127 changed files with 2,106 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/

## All modules:

| Name |
|---|
| [navigation-compose](navigation-compose/index.md) | |
| [navigation-core](navigation-core/index.md) | |
9 changes: 9 additions & 0 deletions docs/navigation-compose/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
//[navigation-compose](index.md)

# navigation-compose

## Packages

| Name |
|---|
| [com.chrynan.navigation.compose](navigation-compose/com.chrynan.navigation.compose/index.md) |
Original file line number Diff line number Diff line change
@@ -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)()
Original file line number Diff line number Diff line change
@@ -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]<br>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]<br>abstract fun [changeScope](../-compose-scoped-navigator/change-scope.md)(to: [Scope](index.md)) |
| [goBack](../-compose-stack-navigator/go-back.md) | [common]<br>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]<br>@Composable<br>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)&lt;[Key](index.md)&gt;.() -&gt; [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) |

## Properties

| Name | Summary |
|---|---|
| [currentKey](../-compose-navigator/current-key.md) | [common]<br>abstract val [currentKey](../-compose-navigator/current-key.md): [Key](index.md) |
| [currentScope](../-compose-scoped-navigator/current-scope.md) | [common]<br>abstract val [currentScope](../-compose-scoped-navigator/current-scope.md): [Scope](index.md) |
| [initialKey](../-compose-navigator/initial-key.md) | [common]<br>abstract val [initialKey](../-compose-navigator/initial-key.md): [Key](index.md) |
| [initialScope](../-compose-scoped-navigator/initial-scope.md) | [common]<br>abstract val [initialScope](../-compose-scoped-navigator/initial-scope.md): [Scope](index.md) |
| [isInitialized](../-compose-navigator/is-initialized.md) | [common]<br>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]<br>abstract val [keyChanges](../-compose-navigator/key-changes.md): Flow&lt;[Key](index.md)&gt; |
| [scopeChanges](../-compose-scoped-navigator/scope-changes.md) | [common]<br>abstract val [scopeChanges](../-compose-scoped-navigator/scope-changes.md): Flow&lt;[Scope](index.md)&gt; |

## Inheritors

| Name |
|---|
| [ComposeNavigatorByContentViewModel](../-compose-navigator-by-content-view-model/index.md) |
Original file line number Diff line number Diff line change
@@ -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 &lt;[Scope](index.md), [Key](index.md)&gt; [BaseComposeNavigatorByKeyViewModel](-base-compose-navigator-by-key-view-model.md)(initialScope: [Scope](index.md), initialKeys: ([Scope](index.md)) -&gt; [Key](index.md))
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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))
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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))
Original file line number Diff line number Diff line change
@@ -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)&lt;[Scope](index.md), [Key](index.md), [NavigationScope](index.md) : [ComposeNavigationKeyScope](../-compose-navigation-key-scope/index.md)&lt;[Key](index.md)&gt;&gt;(initialScope: [Scope](index.md), initialKeys: ([Scope](index.md)) -&gt; [Key](index.md)) : ViewModel, [ComposeNavigator](../-compose-navigator/index.md)&lt;[Key](index.md)&gt; , [ComposeNavigatorByKey](../-compose-navigator-by-key/index.md)&lt;[Key](index.md)&gt; , [ComposeStackNavigatorByKey](../-compose-stack-navigator-by-key/index.md)&lt;[Key](index.md)&gt; , [ComposeScopedNavigator](../-compose-scoped-navigator/index.md)&lt;[Scope](index.md), [Key](index.md)&gt;

## Functions

| Name | Summary |
|---|---|
| [canGoBack](can-go-back.md) | [common]<br>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]<br>open override fun [changeScope](change-scope.md)(to: [Scope](index.md)) |
| [goBack](go-back.md) | [common]<br>open override fun [goBack](go-back.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
| [goTo](go-to.md) | [common]<br>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]<br>open override val [currentKey](current-key.md): [Key](index.md) |
| [currentScope](current-scope.md) | [common]<br>open override val [currentScope](current-scope.md): [Scope](index.md) |
| [initialKey](initial-key.md) | [common]<br>override val [initialKey](initial-key.md): [Key](index.md) |
| [initialScope](initial-scope.md) | [common]<br>override val [initialScope](initial-scope.md): [Scope](index.md) |
| [isInitialized](is-initialized.md) | [common]<br>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]<br>open override val [keyChanges](key-changes.md): Flow&lt;[Key](index.md)&gt; |
| [scopeChanges](scope-changes.md) | [common]<br>open override val [scopeChanges](scope-changes.md): Flow&lt;[Scope](index.md)&gt; |

## Inheritors

| Name |
|---|
| [ComposeNavigationIntentNavigatorByKeyViewModel](../-compose-navigation-intent-navigator-by-key-view-model/index.md) |
| [ComposeNavigatorByKeyViewModel](../-compose-navigator-by-key-view-model/index.md) |
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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&lt;[Key](index.md)&gt;
Original file line number Diff line number Diff line change
@@ -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&lt;[Scope](index.md)&gt;
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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)&lt;[K](index.md)&gt; : [ComposeNavigationScope](../-compose-navigation-scope/index.md)

## Types

| Name | Summary |
|---|---|
| [Companion](-companion/index.md) | [common]<br>object [Companion](-companion/index.md) |

## Properties

| Name | Summary |
|---|---|
| [navigator](navigator.md) | [common]<br>abstract val [navigator](navigator.md): [ComposeStackNavigatorByContent](../-compose-stack-navigator-by-content/index.md)&lt;[K](index.md)&gt; |
Original file line number Diff line number Diff line change
@@ -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)&lt;[K](index.md)&gt;
Original file line number Diff line number Diff line change
@@ -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)&lt;[Scope](index.md), [Intent](index.md) : [NavigationIntent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)&gt; : [BaseComposeNavigatorByKeyViewModel](../-base-compose-navigator-by-key-view-model/index.md)&lt;[Scope](index.md), [Intent](index.md), [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)&lt;[Intent](index.md)&gt;&gt; , [ComposeNavigationIntentStackNavigatorByKey](../-compose-navigation-intent-stack-navigator-by-key/index.md)&lt;[Intent](index.md)&gt;

## Functions

| Name | Summary |
|---|---|
| [canGoBack](../-base-compose-navigator-by-key-view-model/can-go-back.md) | [common]<br>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]<br>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]<br>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]<br>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]<br>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)&lt;[Intent](index.md)&gt;) |
| [onGoBack](../-compose-navigation-intent-stack-navigator-by-key/on-go-back.md) | [common]<br>open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)&lt;[Intent](index.md)&gt;.[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]<br>open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)&lt;[Intent](index.md)&gt;.[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]<br>open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)&lt;[Intent](index.md)&gt;.[onGoUp](../-compose-navigation-intent-stack-navigator-by-key/on-go-up.md)() |
| [onNavigate](index.md#815856985%2FFunctions%2F-1093353005) | [common]<br>open override fun [ComposeNavigationIntentScope](../-compose-navigation-intent-scope/index.md)&lt;[Intent](index.md)&gt;.[onNavigate](index.md#815856985%2FFunctions%2F-1093353005)(event: [NavigationEvent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-event/index.md)&lt;[Intent](index.md)&gt;) |

## Properties

| Name | Summary |
|---|---|
| [currentKey](../-base-compose-navigator-by-key-view-model/current-key.md) | [common]<br>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]<br>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]<br>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]<br>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]<br>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]<br>open override val [keyChanges](../-base-compose-navigator-by-key-view-model/key-changes.md): Flow&lt;[Intent](index.md)&gt; |
| [scopeChanges](../-base-compose-navigator-by-key-view-model/scope-changes.md) | [common]<br>open override val [scopeChanges](../-base-compose-navigator-by-key-view-model/scope-changes.md): Flow&lt;[Scope](index.md)&gt; |
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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)&lt;[I](index.md) : [NavigationIntent](../../../../navigation-core/navigation-core/com.chrynan.navigation/-navigation-intent/index.md)&gt; : [ComposeNavigationKeyScope](../-compose-navigation-key-scope/index.md)&lt;[I](index.md)&gt;

## Types

| Name | Summary |
|---|---|
| [Companion](-companion/index.md) | [common]<br>object [Companion](-companion/index.md) |

## Properties

| Name | Summary |
|---|---|
| [navigator](navigator.md) | [common]<br>abstract override val [navigator](navigator.md): [ComposeNavigationIntentStackNavigatorByKey](../-compose-navigation-intent-stack-navigator-by-key/index.md)&lt;[I](index.md)&gt; |
Original file line number Diff line number Diff line change
@@ -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)&lt;[I](index.md)&gt;

0 comments on commit 96215be

Please sign in to comment.