From f48e6dbf813e86fa2f11ea4f02c6351fbcadf4b9 Mon Sep 17 00:00:00 2001 From: Chris Keenan <10093880+chRyNaN@users.noreply.github.com> Date: Fri, 28 Jul 2023 13:50:51 -0500 Subject: [PATCH] Generated updated documentation --- .../com.chrynan.navigation/-navigation-view-model/index.md | 2 +- .../navigation-core/com.chrynan.navigation/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-view-model/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-view-model/index.md index c142536..3906708 100644 --- a/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-view-model/index.md +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/-navigation-view-model/index.md @@ -10,7 +10,7 @@ Represents a "ViewModel" component used for navigation purposes. This [android]\ actual abstract class [NavigationViewModel](index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html) -[js, jvm]\ +[js, jvm, native]\ actual abstract class [NavigationViewModel](index.md) ## Functions diff --git a/docs/navigation-core/navigation-core/com.chrynan.navigation/index.md b/docs/navigation-core/navigation-core/com.chrynan.navigation/index.md index 5495193..b252456 100644 --- a/docs/navigation-core/navigation-core/com.chrynan.navigation/index.md +++ b/docs/navigation-core/navigation-core/com.chrynan.navigation/index.md @@ -14,7 +14,7 @@ | [NavigationState](-navigation-state/index.md) | [common]
@Serializable(with = [NavigationStateSerializer::class](../../../navigation-core/com.chrynan.navigation/-navigation-state-serializer/index.md))
interface [NavigationState](-navigation-state/index.md)<[T](-navigation-state/index.md)>
A generic wrapper around the state of a navigation component. This provides a way to access the retained [initial](-navigation-state/initial.md) state value, the [current](-navigation-state/current.md) state value, and [changes](-navigation-state/changes.md) to the state value. | | [NavigationStateStore](-navigation-state-store/index.md) | [common]
@Serializable(with = [NavigationStateStoreSerializer::class](../../../navigation-core/com.chrynan.navigation/-navigation-state-store-serializer/index.md))
interface [NavigationStateStore](-navigation-state-store/index.md)<[Destination](-navigation-state-store/index.md) : [NavigationDestination](index.md#1223765350%2FClasslikes%2F-215881696), [Context](-navigation-state-store/index.md) : [NavigationContext](-navigation-context/index.md)<[Destination](-navigation-state-store/index.md)>>
Represents a store of navigation state information that is useful for a [Navigator](-navigator/index.md). | | [NavigationStrategy](-navigation-strategy/index.md) | [common]
interface [NavigationStrategy](-navigation-strategy/index.md)
A component that encapsulates the various navigation policies for a [Navigator](-navigator/index.md). | -| [NavigationViewModel](-navigation-view-model/index.md) | [common]
expect abstract class [NavigationViewModel](-navigation-view-model/index.md)
Represents a "ViewModel" component used for navigation purposes. This component should not be used outside this navigation library.
[android, js, jvm]
[android]
actual abstract class [NavigationViewModel](-navigation-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)
[js, jvm]
actual abstract class [NavigationViewModel](-navigation-view-model/index.md) | +| [NavigationViewModel](-navigation-view-model/index.md) | [common]
expect abstract class [NavigationViewModel](-navigation-view-model/index.md)
Represents a "ViewModel" component used for navigation purposes. This component should not be used outside this navigation library.
[android, js, jvm, native]
[android]
actual abstract class [NavigationViewModel](-navigation-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)
[js, jvm, native]
actual abstract class [NavigationViewModel](-navigation-view-model/index.md) | | [Navigator](-navigator/index.md) | [common]
@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)
@Serializable(with = [NavigatorSerializer::class](../../../navigation-core/com.chrynan.navigation/-navigator-serializer/index.md))
interface [Navigator](-navigator/index.md)<[Destination](-navigator/index.md) : [NavigationDestination](index.md#1223765350%2FClasslikes%2F-215881696), [Context](-navigator/index.md) : [NavigationContext](-navigation-context/index.md)<[Destination](-navigator/index.md)>>
A [Navigator](-navigator/index.md) is responsible for coordinating the navigation between the different UI component groupings in an application. It is a stateful component that reacts to [NavigationEvent](-navigation-event/index.md)s that are emitted via calls to the navigation functions ([push](push.md), [popDestination](pop-destination.md), and [push](push.md)) and updates its stored state values which can be accessed via its state [store](-navigator/store.md). It is up to the user of a [Navigator](-navigator/index.md) to subscribe to the state changes of this component and update the associated UI accordingly. | | [SingleNavigationContext](-single-navigation-context/index.md) | [common]
@Serializable
class [SingleNavigationContext](-single-navigation-context/index.md)<[Destination](-single-navigation-context/index.md) : [NavigationDestination](index.md#1223765350%2FClasslikes%2F-215881696)> : [NavigationContext](-navigation-context/index.md)<[Destination](-single-navigation-context/index.md)>
An implementation of the [NavigationContext](-navigation-context/index.md) interface that doesn't have multiple contexts. Typically, a [NavigationContext](-navigation-context/index.md) will either be a sealed class or an enum representing the different contexts for navigation. This is common, for instance, for a UI with a bottom navigation bar, where each navigation item in that bottom navigation bar component would be a different context. Each context would retain its own stack of destinations in the [Navigator](-navigator/index.md). However, sometimes it may be preferable to have only a single context for navigation, and in this case, this class can be used. |