Package-level declarations

annotation class CachedValue

Annotates a parameter to a component's spec method indicating that it will be supplied as a cached value.

Comparable

annotation class Comparable

Annotates a parameter (Prop, TreeProp or State) indicating what kind of equivalence should be used in the "isEquivalentTo" call.

Event

annotation class Event

EventHandlerRebindMode

enum EventHandlerRebindMode : Enum<EventHandlerRebindMode>

ExcuseMySpec

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ExcuseMySpec(val reason: Reason)

Spec API usage in Kotlin is deprecated and new Specs will be generally treated as errors. But there are certain cases when Specs in Kotlin should be allowed. This annotation is used to mark such usecases and suppress the linter, an explicit reason is required.

FromBoundsDefined

annotation class FromBoundsDefined

FromBoundsDefined is used to pass objects from the OnBoundsDefined lifecycle methods of MountSpec to lifecycle methods called successively such as OnMount or OnBind method, use FromBoundsDefined with the same type and name to retrieve your previously set To use it, simply declare a parameter of type com.facebook.litho.Output<> within the method annotated with OnBoundsDefined.

FromEvent

annotation class FromEvent

Annotates a parameter to a component's event handler callback method indicating that it will be supplied by the event object.

FromMeasure

annotation class FromMeasure

Annotates that the argument's value should be set to the named inter-stage output from the lifecycle method.

FromMeasureBaseline

annotation class FromMeasureBaseline

FromPrepare

annotation class FromPrepare

FromPrepare is used to pass objects from the OnPrepare lifecycle methods of MountSpec to lifecycle methods called successively such as OnMount or method, use FromPrepare with the same type and name to retrieve your previously set To use it, simply declare a parameter of type com.facebook.litho.Output<> within the method annotated with OnPrepare.

FromTrigger

annotation class FromTrigger

Parameters declared in a class annotated with Event that are used in OnTriggerFor example:

@LayoutSpec
public class ComponentSpec {

 @OnTrigger(YourEvent.class)
  static Object yourEventClick(ComponentContext c,@FromTrigger YourObject obj) {
    return new Object();
  }
}

Generated

GetExtraAccessibilityNodeAt

annotation class Generated

GetExtraAccessibilityNodesCount

annotation class GetExtraAccessibilityNodeAt

ImportantForAccessibility

annotation class GetExtraAccessibilityNodesCount

annotation class ImportantForAccessibility

LayoutSpec

annotation class ~~LayoutSpec~~

A class that is annotated with this annotation will be used to create a composite component that is made up of other components.

MountingType

enum MountingType

MountSpec

@Documented

annotation class ~~MountSpec~~

A class that is annotated with this annotation will be used to create a component that renders something, in the form of either a Drawable or a View.

OnAttached

annotation class OnAttached

A method annotated with this annotation is called when the component is attached to the ComponentTree.

OnBind

annotation class OnBind

A method annotation used in classes that are annotated with MountSpec.

OnBindDynamicValue

annotation class OnBindDynamicValue

EXPERIMENTAL.

OnBoundsDefined

annotation class OnBoundsDefined

OnCalculateCachedValue

annotation class OnCalculateCachedValue

Annotation for a method on a component's spec that indicates that the method is used to calculate a value that is cached by the component, and may be access in methods using CachedValue.

OnCreateInitialState

annotation class OnCreateInitialState

This annotation is used in a LayoutSpec; the framework calls the method annotated with OnCreateInitialState before resolving its layout, i.e.

OnCreateLayout

OnCreateLayoutWithSizeSpec

annotation class OnCreateLayout

This annotation is used in conjugation with LayoutSpec.

annotation class OnCreateLayoutWithSizeSpec

OnCreateLayoutWithSizeSpec is the same as OnCreateLayout but the layout can be resolved with a specified width and height.

OnCreateMountContent

annotation class OnCreateMountContent

The method annotated with this annotation will be called to instantiate the mount content for the MountSpec, when the pool of objects corresponding to this mount content type is empty and recycling is not possible.

OnCreateMountContentPool

annotation class OnCreateMountContentPool

The annotated method will be called to create a custom MountContentPool for this mount spec.

OnCreateTransition

annotation class OnCreateTransition

Annotation for a method that specifies how to animate this component to its new layout and props.

OnCreateTreeProp

annotation class OnCreateTreeProp

An annotation for a Spec method that generates tree props.

OnDetached

annotation class OnDetached

A method annotated with this annotation is called when the component is detached from the ComponentTree.

OnEnteredRange

annotation class OnEnteredRange

Annotated function in the component will allow it be called when entering a working range.

OnError

annotation class OnError

Annotate a method inside your component with @OnError to receive a callback when an exception inside supported delegate methods of a child component happens.

OnEvent

annotation class OnEvent

Annotation for event handling.

OnExitedRange

annotation class OnExitedRange

Annotated function in the component will allow it be called when exiting a working range.

OnLoadStyle

annotation class OnLoadStyle

OnMeasure

annotation class OnMeasure

A method annotation used in classes that are annotated with MountSpec.

OnMeasureBaseline

annotation class OnMeasureBaseline

A method that is annotated with this annotation will be used to compute the baseline of your component.

OnMount

OnPerformActionForVirtualView

annotation class OnMount

A method annotated with OnMount is called on a MountSpec component before the component is attached to a hosting view.

OnPopulateAccessibilityNode

annotation class OnPerformActionForVirtualView

OnPopulateExtraAccessibilityNode

annotation class OnPopulateAccessibilityNode

annotation class OnPopulateExtraAccessibilityNode

OnPrepare

annotation class OnPrepare

A MountSpec can define a method annotated with OnPrepare to run code that is more heavy and cannot be done during OnMount or OnBind.

OnRegisterRanges

annotation class ~~OnRegisterRanges~~

Deprecated: Please avoid using this annotation and it will be not supported in the future release The method annotated with this annotation will be called to register working ranges for the LayoutSpec.

OnTrigger

annotation class OnTrigger

Annotated function in the component will allow its parents to call it with an EventTrigger.

OnUnbind

annotation class OnUnbind

A method annotation used in classes that are annotated with MountSpec.

OnUnmount

annotation class OnUnmount

OnUpdateState

OnUpdateStateWithTransition

annotation class OnUpdateState

Used to mark a method that can update the state of a Component.

OnVirtualViewKeyboardFocusChanged

annotation class OnUpdateStateWithTransition

Used to mark a method that can update the state of a Component and trigger Transition returned from this method.

annotation class OnVirtualViewKeyboardFocusChanged

Param

annotation class Param

Params can be used together with Event callbacks i.e.

Prop

annotation class Prop

Inputs to a Component are its props.

PropDefault

annotation class PropDefault

PropDefault can be used for setting the default value of an optional Prop in a LayoutSpec or MountSpec.

PropSetter

annotation class PropSetter

Indicates that a method implementation sets Prop.

Reason

enum Reason : Enum<Reason>

RequiredProp

annotation class RequiredProp

Indicates that a method implementation sets required Prop.

ResType

enum ResType

This enum's constants are used to mark that Prop can receive resources of a corresponding Android resource type as values.

ShouldAlwaysRemeasure

ShouldExcludeFromIncrementalMount

annotation class ShouldAlwaysRemeasure

Annotated function in the component will allow it always be measured when receiving a remeasure event no matter the SizeSpecs are changed or not.

annotation class ShouldExcludeFromIncrementalMount

Annotated function in the component will inform the framework that if this particular instance of the component should be excluded from Incremental Mount.

ShouldUpdate

annotation class ShouldUpdate

State

annotation class State

States for a given Component are the union of all arguments annotated with State in the spec.

TestSpec

annotation class TestSpec

An interface that is annotated with this annotation will be used to generate a matcher based on the underlying spec.

TreeProp