soil-space/soil.space.compose

Package-level declarations

Types

AtomSaveableStore

class AtomSaveableStore(savedState: Bundle? = null) : AtomStore, SavedStateRegistry.SavedStateProvider

A AtomStore implementation that saves and restores the state of Atoms.

AtomState

@Stable

class AtomState<T>(state: State<T>, update: (T) -> Unit) : MutableState<T>

MutableState for handling the state values of Atom managed by AtomStore.

AtomValue

@Stable

class AtomValue<T>(state: State<T>) : State<T>

State for handling the state values of Atom managed by AtomStore.

AtomViewModel

class AtomViewModel(handle: SavedStateHandle) : ViewModel

A ViewModel for managing AtomStore.

Properties

LocalAtomOwner

val LocalAtomOwner: ProvidableCompositionLocal<AtomStore>

CompositionLocal for AtomStore.

Functions

AtomRoot

@Composable

fun AtomRoot(store: AtomStore, content: @Composable () -> Unit)

Provides a single AtomStore.

@Composable

fun AtomRoot(primary: Pair<AtomScope, AtomStore>, vararg others: Pair<AtomScope, AtomStore>, fallbackScope: (Atom<*>) -> AtomScope = { primary.first }, content: @Composable () -> Unit)

Provides multiple AtomStore. You can provide AtomStore corresponding to AtomScope with different lifecycles.

rememberAtomState

@Composable

fun <T> rememberAtomState(atom: Atom<T>, store: AtomStore = LocalAtomOwner.current): AtomState<T>

Remember an AtomState for the specified Atom reference key.

rememberAtomValue

@Composable

fun <T> rememberAtomValue(atom: AtomRef<T>, store: AtomStore = LocalAtomOwner.current): AtomValue<T>

Remember an AtomValue for the specified AtomRef reference key.

@Composable

fun <T> rememberAtomValue(atom: Atom<T>, store: AtomStore = LocalAtomOwner.current): AtomValue<T>

Remember an AtomValue for the specified Atom reference key.

rememberSaveableStore

@Composable

fun rememberSaveableStore(key: String? = null): AtomStore

Remember a AtomSaveableStore that saves and restores the state of Atoms.

rememberViewModelStore

@Composable

fun rememberViewModelStore(key: String? = null): AtomStore

@Composable

fun rememberViewModelStore(viewModelStoreOwner: ViewModelStoreOwner, key: String? = null): AtomStore

Remember an AtomStore using AtomViewModel.