navigation-screens-viewmodel/io.github.lukwol.navigation.screens.viewmodel/ViewModel

ViewModel

actual abstract class ViewModel : ViewModel

expect abstract class ViewModel

ViewModel is tied to specific view, it exposes the view state and encapsulates related business logic.

When used in a combination with screens and/or windows navigation, ViewModel is tightly integrated into screens and windows navigation, by exposing lifecycle aware coroutineScope, that is canceled whenever screen or window is dismissed.

ViewModel allows to persists the view state when screen is not currently active until it's dismissed.

ViewModel separate implementations for Android and non Android targets.

On Android ViewModel inherits from official Android ViewModel class and coroutineScope is just another way to reference viewModelScope.

Other targets have common implementation where ViewModel does not inherit from any class and creates it's own new coroutineScope when instantiating this class.

actual abstract class ViewModel

Constructors

ViewModel

constructor()

expect constructor()

constructor()

Properties

coroutineScope

actual val coroutineScope: CoroutineScope

expect val coroutineScope: CoroutineScope

This scope will be canceled when view connected to this CoroutineScopeAware implementation is cleared.

actual val coroutineScope: CoroutineScope

viewModelScope

val ViewModel.viewModelScope: CoroutineScope

Functions

addCloseable

open fun addCloseable(@NonNull p0: Closeable)