Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed Jul 28, 2023
1 parent 4b0b788 commit f48e6db
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| [NavigationState](-navigation-state/index.md) | [common]<br>@Serializable(with = [NavigationStateSerializer::class](../../../navigation-core/com.chrynan.navigation/-navigation-state-serializer/index.md))<br>interface [NavigationState](-navigation-state/index.md)&lt;[T](-navigation-state/index.md)&gt;<br>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]<br>@Serializable(with = [NavigationStateStoreSerializer::class](../../../navigation-core/com.chrynan.navigation/-navigation-state-store-serializer/index.md))<br>interface [NavigationStateStore](-navigation-state-store/index.md)&lt;[Destination](-navigation-state-store/index.md) : [NavigationDestination](index.md#1223765350%2FClasslikes%2F-215881696), [Context](-navigation-state-store/index.md) : [NavigationContext](-navigation-context/index.md)&lt;[Destination](-navigation-state-store/index.md)&gt;&gt;<br>Represents a store of navigation state information that is useful for a [Navigator](-navigator/index.md). |
| [NavigationStrategy](-navigation-strategy/index.md) | [common]<br>interface [NavigationStrategy](-navigation-strategy/index.md)<br>A component that encapsulates the various navigation policies for a [Navigator](-navigator/index.md). |
| [NavigationViewModel](-navigation-view-model/index.md) | [common]<br>expect abstract class [NavigationViewModel](-navigation-view-model/index.md)<br>Represents a &quot;ViewModel&quot; component used for navigation purposes. This component should not be used outside this navigation library.<br>[android, js, jvm]<br>[android]<br>actual abstract class [NavigationViewModel](-navigation-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)<br>[js, jvm]<br>actual abstract class [NavigationViewModel](-navigation-view-model/index.md) |
| [NavigationViewModel](-navigation-view-model/index.md) | [common]<br>expect abstract class [NavigationViewModel](-navigation-view-model/index.md)<br>Represents a &quot;ViewModel&quot; component used for navigation purposes. This component should not be used outside this navigation library.<br>[android, js, jvm, native]<br>[android]<br>actual abstract class [NavigationViewModel](-navigation-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)<br>[js, jvm, native]<br>actual abstract class [NavigationViewModel](-navigation-view-model/index.md) |
| [Navigator](-navigator/index.md) | [common]<br>@[ExperimentalNavigationApi](-experimental-navigation-api/index.md)<br>@Serializable(with = [NavigatorSerializer::class](../../../navigation-core/com.chrynan.navigation/-navigator-serializer/index.md))<br>interface [Navigator](-navigator/index.md)&lt;[Destination](-navigator/index.md) : [NavigationDestination](index.md#1223765350%2FClasslikes%2F-215881696), [Context](-navigator/index.md) : [NavigationContext](-navigation-context/index.md)&lt;[Destination](-navigator/index.md)&gt;&gt;<br>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]<br>@Serializable<br>class [SingleNavigationContext](-single-navigation-context/index.md)&lt;[Destination](-single-navigation-context/index.md) : [NavigationDestination](index.md#1223765350%2FClasslikes%2F-215881696)&gt; : [NavigationContext](-navigation-context/index.md)&lt;[Destination](-single-navigation-context/index.md)&gt; <br>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. |

Expand Down

0 comments on commit f48e6db

Please sign in to comment.