compose/pro.respawn.flowmvi.compose.dsl

Package-level declarations

Properties

asLifecycleState

@Stable

val SubscriptionMode.asLifecycleState: Lifecycle.State

Converts this SubscriptionMode to a Lifecycle.State

asSubscriptionMode

@Stable

val Lifecycle.State.asSubscriptionMode: SubscriptionMode

Converts the Lifecycle.State to a SubscriptionMode

DefaultLifecycle

@get:Composable

val DefaultLifecycle: SubscriberLifecycle

Get the current provided subscriber lifecycle, or if not found, fall back to the platform-provided lifecycle

LocalSubscriberLifecycle

val LocalSubscriberLifecycle: ProvidableCompositionLocal<SubscriberLifecycle?>

A local composition SubscriberLifecycle instance. May return null if no lifecycle was provided. Can be provided with ProvideSubscriberLifecycle.

Functions

ProvideSubscriberLifecycle

@Composable

fun ProvideSubscriberLifecycle(lifecycle: SubscriberLifecycle, content: @Composable () -> Unit)

Provides LocalSubscriberLifecycle with an instance of lifecycle for child content.

rememberSubscriberLifecycle

@Composable

fun <T> rememberSubscriberLifecycle(delegate: T, factory: T.() -> SubscriberLifecycle): SubscriberLifecycle

Remember a new subscriber lifecycle instance from delegate to convert it using factory

requireLifecycle

@Composable

fun requireLifecycle(): SubscriberLifecycle

Require LocalSubscriberLifecycle to be provided using a composition local.

@JvmName(name = "subscribeAndConsume")

fun <S : MVIState, I : MVIIntent, A : MVIAction, T : LifecycleOwner, StateConsumer<S>, ActionConsumer<A>> T.subscribe(provider: Store<S, I, A>, lifecycleState: Lifecycle.State = Lifecycle.State.STARTED): Job

Subscribe to the store lifecycle-aware.

fun <S : MVIState, I : MVIIntent, A : MVIAction, T : LifecycleOwner, StateConsumer<S>> T.subscribe(provider: Store<S, I, A>, lifecycleState: Lifecycle.State = Lifecycle.State.STARTED): Job

Subscribe to the store lifecycle-aware. This function will not collect the store's actions.

@Composable

fun <S : MVIState, I : MVIIntent, A : MVIAction> ImmutableStore<S, I, A>.subscribe(lifecycle: SubscriberLifecycle = DefaultLifecycle, mode: SubscriptionMode = SubscriptionMode.Started): State<S>

@Composable

@JvmName(name = "subscribeConsume")

fun <S : MVIState, I : MVIIntent, A : MVIAction> ImmutableStore<S, I, A>.subscribe(lifecycle: SubscriberLifecycle = DefaultLifecycle, mode: SubscriptionMode = SubscriptionMode.Started, consume: suspend CoroutineScope.(action: A) -> Unit): State<S>

A function to subscribe to the store that follows the system lifecycle.

inline fun <S : MVIState, I : MVIIntent, A : MVIAction> LifecycleOwner.subscribe(store: Store<S, I, A>, crossinline render: suspend (state: S) -> Unit, lifecycleState: Lifecycle.State = Lifecycle.State.STARTED): Job

inline fun <S : MVIState, I : MVIIntent, A : MVIAction> LifecycleOwner.subscribe(store: Store<S, I, A>, noinline consume: suspend (action: A) -> Unit, crossinline render: suspend (state: S) -> Unit, lifecycleState: Lifecycle.State = Lifecycle.State.STARTED): Job

Subscribe to the store lifecycle-aware.