Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris committed Apr 14, 2023
1 parent 9600b52 commit 63f1acc
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 @@ -2,7 +2,7 @@

# PlatformViewModel

expect abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)actual abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md)
expect abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)actual abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md)

The base class that a [ViewModel](../-view-model/index.md) inherits from. This allows each supported platform to have a platform-specific base ViewModel component implementation. For instance, on Android this class can extend from the `androidx.lifecycle.ViewModel` component so that it can be used with the Android lifecycle.

Expand Down
2 changes: 1 addition & 1 deletion docs/cycle-core/cycle-core/com.chrynan.cycle/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
| [IntentViewModel](-intent-view-model/index.md) | [common]<br>@FlowPreview<br>@ExperimentalCoroutinesApi<br>abstract class [IntentViewModel](-intent-view-model/index.md)&lt;[Intent](-intent-view-model/index.md), [State](-intent-view-model/index.md), [Change](-intent-view-model/index.md)&gt;(stateStore: [MutableStateStore](-mutable-state-store/index.md)&lt;[State](-intent-view-model/index.md), [Change](-intent-view-model/index.md)&gt;, dispatchers: CoroutineDispatchers = com.chrynan.dispatchers.dispatchers, resetOnUnbind: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, flatMapStrategy: [FlatMapStrategy](-flat-map-strategy/index.md) = FlatMapStrategy.Latest) : [ViewModel](-view-model/index.md)&lt;[State](-intent-view-model/index.md), [Change](-intent-view-model/index.md)&gt; <br>An abstract implementation of a [ViewModel](-view-model/index.md) that supports the MVI (Model-View-Intent) design pattern. Inheritors of this class must implement the [performIntentAction](../../../cycle-core/com.chrynan.cycle/-intent-view-model/perform-intent-action.md) function which associates an [Action](index.md#-1083546810%2FClasslikes%2F1627176608) with an [Intent](-intent-view-model/index.md). To emit an [Intent](-intent-view-model/index.md) on an [IntentViewModel](-intent-view-model/index.md), use the [IntentViewModel.intent](-intent-view-model/intent.md) function. |
| [MutableStackStateStore](-mutable-stack-state-store/index.md) | [common]<br>interface [MutableStackStateStore](-mutable-stack-state-store/index.md)&lt;[State](-mutable-stack-state-store/index.md), [Change](-mutable-stack-state-store/index.md)&gt; : [MutableStateStore](-mutable-state-store/index.md)&lt;[State](-mutable-stack-state-store/index.md), [Change](-mutable-stack-state-store/index.md)&gt; <br>A [MutableStateStore](-mutable-state-store/index.md) that has basic Stack data structure functions that allow going back to previous [State](-mutable-stack-state-store/index.md)s. |
| [MutableStateStore](-mutable-state-store/index.md) | [common]<br>interface [MutableStateStore](-mutable-state-store/index.md)&lt;[State](-mutable-state-store/index.md), [Change](-mutable-state-store/index.md)&gt; : [StateStore](-state-store/index.md)&lt;[State](-mutable-state-store/index.md), [Change](-mutable-state-store/index.md)&gt; <br>A mutable [StateStore](-state-store/index.md) where the state can be altered by dispatching changes via the [dispatch](-mutable-state-store/dispatch.md) function. |
| [PlatformViewModel](-platform-view-model/index.md) | [common]<br>expect abstract class [PlatformViewModel](-platform-view-model/index.md)<br>The base class that a [ViewModel](-view-model/index.md) inherits from. This allows each supported platform to have a platform-specific base ViewModel component implementation. For instance, on Android this class can extend from the `androidx.lifecycle.ViewModel` component so that it can be used with the Android lifecycle.<br>[android, js, jvm]<br>[android]<br>actual abstract class [PlatformViewModel](-platform-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)<br>[js, jvm]<br>actual abstract class [PlatformViewModel](-platform-view-model/index.md) |
| [PlatformViewModel](-platform-view-model/index.md) | [common]<br>expect abstract class [PlatformViewModel](-platform-view-model/index.md)<br>The base class that a [ViewModel](-view-model/index.md) inherits from. This allows each supported platform to have a platform-specific base ViewModel component implementation. For instance, on Android this class can extend from the `androidx.lifecycle.ViewModel` component so that it can be used with the Android lifecycle.<br>[android, ios, js, jvm]<br>[android]<br>actual abstract class [PlatformViewModel](-platform-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)<br>[ios, js, jvm]<br>actual abstract class [PlatformViewModel](-platform-view-model/index.md) |
| [PresentationFragment](-presentation-fragment/index.md) | [android]<br>@FlowPreview<br>@ExperimentalCoroutinesApi<br>abstract class [PresentationFragment](-presentation-fragment/index.md)&lt;[State](-presentation-fragment/index.md), [Change](-presentation-fragment/index.md)&gt; : [Fragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.html), [View](../../../cycle-core/cycle-core/com.chrynan.cycle/-view/index.md)&lt;[State](-presentation-fragment/index.md), [Change](-presentation-fragment/index.md)&gt; <br>An Android [Fragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.html) base implementation of a [View](../../../cycle-core/cycle-core/com.chrynan.cycle/-view/index.md) for use with this library's design pattern. |
| [Reducer](index.md#-209270086%2FClasslikes%2F1627176608) | [common]<br>typealias [Reducer](index.md#-209270086%2FClasslikes%2F1627176608)&lt;[State](index.md#-209270086%2FClasslikes%2F1627176608), [Change](index.md#-209270086%2FClasslikes%2F1627176608)&gt; = suspend [State](index.md#-209270086%2FClasslikes%2F1627176608)?.([Change](index.md#-209270086%2FClasslikes%2F1627176608)) -&gt; [State](index.md#-209270086%2FClasslikes%2F1627176608)?<br>A [Reducer](index.md#-209270086%2FClasslikes%2F1627176608) is responsible for determining the State that is displayed in the UI. A [Reducer](index.md#-209270086%2FClasslikes%2F1627176608) is a function that takes the current State and a Change and derives a new State. |
| [StateStore](-state-store/index.md) | [common]<br>interface [StateStore](-state-store/index.md)&lt;[State](-state-store/index.md), [Change](-state-store/index.md)&gt;<br>A component that holds the whole state tree for a [ViewModel](-view-model/index.md). The only way to change the state inside it is to dispatch a [Change](-state-store/index.md) to it. |
Expand Down

0 comments on commit 63f1acc

Please sign in to comment.