litho-coroutines-kotlin/com.facebook.litho

Package-level declarations

Types

ComponentTreeScope

class ComponentTreeScope(lithoTree: LithoTree, val coroutineContext: CoroutineContext) : CoroutineScope

A CoroutineScope that is scoped to whether the ComponentTree is released.

StateProducerScope

interface StateProducerScope<T> : CoroutineScope

Properties

lithoTreeScope

val LithoTree.lithoTreeScope: CoroutineScope

Lazily creates a CoroutineScope that will be active as long as the ComponentTree is not released. This scope will be canceled when the ComponentTree is released.

Functions

useComponentCoroutineScope

fun ComponentScope.useComponentCoroutineScope(coroutineContext: CoroutineContext = EmptyCoroutineContext): CoroutineScope

Return a CoroutineScope that is be active as long as the Component in which it was created is present in the UI tree. The same CoroutineScope instance will be returned across re-renders.

useCoroutine

fun ComponentScope.~~useCoroutine~~(onLaunch: suspend CoroutineScope.() -> Unit)

Launches a coroutine with onLaunch. The coroutine will be canceled when the component is detached, or if the coroutine will be relaunched.

fun ComponentScope.useCoroutine(vararg keys: Any?, onLaunch: suspend CoroutineScope.() -> Unit)

Launches a coroutine with onLaunch whenever keys change. The coroutine will be canceled when the component is detached, or if the coroutine will be relaunched.

useFlow

fun <T> ComponentScope.useFlow(stateFlow: StateFlow<T>): T

Uses the current value of a given stateFlow in a Litho Kotlin component.

fun <T> ComponentScope.~~useFlow~~(initialValue: () -> T, flowBlock: suspend () -> StateFlow<T>)

Uses the collection of a StateFlow that is dynamically supplied by flowBlock.

fun <T> ComponentScope.useFlow(initialValue: () -> T, vararg keys: Any?, flowBlock: suspend () -> StateFlow<T>): T

Uses the collection of a StateFlow that is dynamically supplied by flowBlock, which will be executed whenever the given keys change.

useFlowWithLifecycle

fun <T> ComponentScope.useFlowWithLifecycle(stateFlow: StateFlow<T>, minActiveState: Lifecycle.State = Lifecycle.State.RESUMED): T

Returns the current value of a given stateFlow.

useProducer

fun <T> ComponentScope.useProducer(initialValue: () -> T, vararg keys: Any?, producer: suspend StateProducerScope<T>.() -> Unit): T

Creates a value that is updatable by a given producer coroutine. Whenever producer updates the value, the component will be re-rendered.