Composable Function

collectAsState

Collects values from this StateFlow and represents its latest value via State.

RevenueCat

RevenueCat

Add subscriptions to your apps in minutes

Ad Get started for free

collectAsState

Common
@Composable
public fun <T> StateFlow<T>.collectAsState(
    context: CoroutineContext = EmptyCoroutineContext
): State<T>

Collects values from this StateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

Parameters
context CoroutineContext to use for collecting.

collectAsState

Common
@Composable
public fun <T : R, R> Flow<T>.collectAsState(
    initial: R,
    context: CoroutineContext = EmptyCoroutineContext,
): State<R>

Collects values from this Flow and represents its latest value via State. Every time there would be new value posted into the Flow the returned State will be updated causing recomposition of every State.value usage.

Parameters
initial the value of the state will have until the first flow value is emitted.
context CoroutineContext to use for collecting.