litho-core/com.facebook.litho.effects/EffectHandler

EffectHandler

Manages the execution and update of effects within a ComponentTree.

For Spec Components, this will invoke OnAttached when a component is attached to the ComponentTree and OnDetached when a component is detached from the tree.

For Kotlin components, this will handle dispatching callbacks registered with the useEffect hook.

Types

Companion

object Companion

Properties

effects

abstract val effects: Collection<Effect>?

Functions

hasReadsFor

open fun hasReadsFor(updatedState: Set<StateId>): Boolean

Whether any currently-attached effect recorded a read of any of updatedState.

onCleanup

abstract fun onCleanup()

Removes all associated Effects and any transient state.

updateAndRun

inline fun EffectHandler.updateAndRun(context: EffectContext, newEffects: List<Effect>?, onUpdate: () -> Unit)

updateEffects

abstract fun EffectContext.updateEffects(effects: List<Effect>?): Runnable

Updates the set of effects within the associated ComponentTree.