This method determine if transitions are enabled for the user. If the experiment is enabled for the user then they will get cached value else it will be determined using the utility method.

asResourcesScope

fun ComponentContext.asResourcesScope(): ResourcesScope

Wraps this existing ComponentContext in a ResourcesScope, for calling the ResourcesScope DSL (Row, Column, widgets such as Card) from code that already holds a ComponentContext but has no ambient ComponentScope — e.g. a @LayoutSpec helper or a builder-style function.

boolAttr

fun ComponentContext.boolAttr(@AttrRes attrResId: Int, @BoolRes defResId: Int = 0): Boolean

Return a boolean for an attribute resource ID.

boolRes

fun ComponentContext.boolRes(@BoolRes id: Int): Boolean

Return a boolean for a resource ID.

calculateLayoutOutputId

fun calculateLayoutOutputId(componentKey: GlobalKey, type: Int): Long

Calculates a returns a unique ID for a given component key and output type. The IDs will be unique for components in the ComponentTree this ID generator is linked with. If an ID was already generated for a given component, the same ID will be returned. Otherwise, a new unique ID will be generated.

clearCalculationStateContext

@VisibleForTesting(otherwise = 3)

fun clearCalculationStateContext()

colorAttr

@ColorInt

fun ComponentContext.colorAttr(@AttrRes id: Int, @ColorRes defResId: Int = 0): Int

Return a ColorInt value, corresponding to an attribute resource ID. If given attribute ID can not be found, default color resource ID defResId is used.

colorRes

@ColorInt

fun ComponentContext.colorRes(@ColorRes id: Int): Int

Return a ColorInt value for a color resource ID.

createEventHandler

fun <E> createEventHandler(id: Int, mode: EventHandlerRebindMode, params: Array<Any?>?, reference: Class<out Component>, source: String): EventHandler<E>

dimenAttr

fun ComponentContext.dimenAttr(@AttrRes id: Int, @DimenRes defResId: Int = 0): Dimen

Return a dimen for an attribute resource ID.

dimenRes

fun ComponentContext.dimenRes(@DimenRes id: Int): Dimen

Resolve a dimen resource ID as a Dimen value.

drawableAttr

fun ComponentContext.drawableAttr(@AttrRes id: Int, @DrawableRes defResId: Int = 0): Drawable

Retrieve a android.graphics.drawable.Drawable, corresponding to an attribute resource ID, as a Drawable instance. If given attribute ID can not be found, default Drawable resource ID defResId is used.

drawableRes

fun ComponentContext.drawableRes(@DrawableRes id: Int): Drawable

Retrieve a android.graphics.drawable.Drawable for a resource ID as a Drawable instance.

enterNoStateUpdatesMethod

fun enterNoStateUpdatesMethod(noStateUpdatesMethod: String)

exitNoStateUpdatesMethod

fun exitNoStateUpdatesMethod()

findViewWithTag

fun <T : View?> findViewWithTag(tag: Any): T?

A utility function to find the View with a given tag under the current Component's LithoView. To set a view tag, use the .viewTag() common prop or Style.viewTag. An appropriate time to call this is in your Component's onVisible callback.

findViewWithTagValue

fun findViewWithTagValue(key: Int, tag: Any): View?

A utility function to find the View with a given tag under the current Component's LithoView. To set a view tag, use the .viewTags() common prop or Style.viewTags. An appropriate time to call this is in your Component's onVisible callback.

floatAttr

fun ComponentContext.floatAttr(@AttrRes id: Int, @DimenRes defResId: Int = 0): Float

floatRes

fun ComponentContext.floatRes(@DimenRes id: Int): Float

getCachedValue

fun getCachedValue(cacheKey: HookGlobalKey, cachedValueInputs: Any): Any?

getColor

fun getColor(@ColorRes id: Int): Int

getParentTreeProp

fun <T : Any> getParentTreeProp(key: Class<T>): T?

getString

fun getString(@StringRes resId: Int): String

fun getString(@StringRes resId: Int, vararg formatArgs: Any?): String

getText

fun getText(@StringRes resId: Int): CharSequence

getTreeProp

fun <T> getTreeProp(key: TreeProp<T>): T

fun <T : Any> getTreeProp(key: Class<T>): T?

intAttr

fun ComponentContext.intAttr(@AttrRes id: Int, @IntegerRes defResId: Int = 0): Int

intRes

fun ComponentContext.intRes(@IntegerRes id: Int): Int

lithoWorkAroundIgnoreMeasureInResolve

fun ~~lithoWorkAroundIgnoreMeasureInResolve~~()

Temporary workaround to suppress the "measure in resolve" violation policy.

makeNewCopy

fun makeNewCopy(): ComponentContext

newEventTrigger

open fun <E> newEventTrigger(id: Int, childKey: String, handle: Handle?): EventTrigger<E>

nullableDrawableRes

fun ComponentContext.nullableDrawableRes(@DrawableRes id: Int?): Drawable?

Retrieve a android.graphics.drawable.Drawable for a resource ID as a Drawable instance, or null if the resource ID is zero or null.

obtainStyledAttributes

fun obtainStyledAttributes(attrs: IntArray, @AttrRes defStyleAttr: Int): TypedArray

putCachedValue

fun putCachedValue(cacheKey: HookGlobalKey, cachedValueInputs: Any, cachedValue: Any?)

quantityStringRes

fun ComponentContext.quantityStringRes(@PluralsRes id: Int, quantity: Int): String

fun ComponentContext.quantityStringRes(@PluralsRes id: Int, quantity: Int, arg: Any?): String

fun ComponentContext.quantityStringRes(@PluralsRes id: Int, quantity: Int, vararg formatArgs: Any?): String

removePendingStateUpdate

fun removePendingStateUpdate(key: GlobalKey, isLayoutState: Boolean)

setDefStyle

fun setDefStyle(@AttrRes defStyleAttr: Int, @StyleRes defStyleRes: Int)

setLayoutStateContextForTesting

@VisibleForTesting(otherwise = 3)

fun setLayoutStateContextForTesting()

setLithoLayoutContext

@VisibleForTesting(otherwise = 3)

fun setLithoLayoutContext(lithoLayoutContext: LithoLayoutContext)

setRenderStateContextForTests

@VisibleForTesting

fun setRenderStateContextForTests(): ResolveContext

For test usage. This method will ensure this ComponentContext has a RenderStateContex. This is critical for tests that trigger layout calculation functionality outside of a LayoutState calculation (i.e., including willRender, Layout API, caching, etc).

stringAttr

fun ComponentContext.stringAttr(@AttrRes attrResId: Int, @StringRes defResId: Int = 0): String

Return a string for an attribute resource ID.

stringRes

fun ComponentContext.stringRes(@StringRes id: Int): String

Return a string for a resource ID.

fun ComponentContext.stringRes(@StringRes id: Int, arg: Any?): String

Return a string for a resource ID, substituting the format arguments with arg.

fun ComponentContext.stringRes(@StringRes id: Int, vararg formatArgs: Any?): String

Return a string for a resource ID, substituting the format arguments with formatArgs.

updateStateAsync

open fun updateStateAsync(stateUpdate: StateContainer.StateUpdate, attribution: String)

Notify the Component Tree that it needs to asynchronously perform a state update.

fun updateStateAsync(stateUpdate: StateContainer.StateUpdate, attribution: String, reference: Class<out Component>)

Variant of updateStateAsync that asserts the update is performed with the ComponentContext of reference — the component that owns the state. Generated by the Spec annotation processor for @OnUpdateState methods; see assertValidStateUpdateContext.

updateStateLazy

open fun updateStateLazy(stateUpdate: StateContainer.StateUpdate)

fun updateStateLazy(stateUpdate: StateContainer.StateUpdate, reference: Class<out Component>)

Variant of updateStateLazy that asserts the update is performed with the ComponentContext of reference — the component that owns the state. Generated by the Spec annotation processor for lazy state updates; see assertValidStateUpdateContext.

updateStateSync

open fun updateStateSync(stateUpdate: StateContainer.StateUpdate, attribution: String)

Notify the Component Tree that it needs to synchronously perform a state update.

fun updateStateSync(stateUpdate: StateContainer.StateUpdate, attribution: String, reference: Class<out Component>)

Variant of updateStateSync that asserts the update is performed with the ComponentContext of reference — the component that owns the state. Generated by the Spec annotation processor for @OnUpdateState methods; see assertValidStateUpdateContext.

updateStateWithTransition

fun updateStateWithTransition(stateUpdate: StateContainer.StateUpdate, attribution: String)

fun updateStateWithTransition(stateUpdate: StateContainer.StateUpdate, attribution: String, reference: Class<out Component>)

Variant of updateStateWithTransition that asserts the update is performed with the ComponentContext of reference — the component that owns the state. Generated by the Spec annotation processor for @OnUpdateStateWithTransition methods.