Implementation of the LinearSnapHelper supporting hscroll custom target child view The implementation will snap the center of the custom target child view to the center of the attached RecyclerView.

DataDiffModelName

interface DataDiffModelName

Interface to provide name of the model used for tracing purposes.

DispatchKeyEvent

class DispatchKeyEvent

EdgeSnappingSmoothScroller

open class EdgeSnappingSmoothScroller : LinearSmoothScroller

LinearSmoothScroller subclass that snaps the target position to start/end or either ends.

EditorActionEvent

open class EditorActionEvent

Event sent by EditText when the return key is pressed or the IME signals an 'action'.

EditTextStateUpdatePolicy

enum EditTextStateUpdatePolicy : Enum<EditTextStateUpdatePolicy>

EditTextStateUpdatePolicy specifies when EditText component should update its internal input state

ExperimentalImage

class ExperimentalImage(drawable: Drawable?, scaleType: ImageView.ScaleType = ScaleType.FIT_CENTER, useIntrinsicSize: Boolean = true, style: Style? = null) : PrimitiveComponent

A component to render a Drawable.

ExperimentalSolidColor

@ExperimentalLithoApi

class ExperimentalSolidColor(@ColorInt color: Int, alpha: Float = -1.0f, style: Style? = null) : KComponent

A component that renders a solid color.

ExperimentalVerticalScroll

class ExperimentalVerticalScroll(val scrollbarEnabled: Boolean, val nestedScrollingEnabled: Boolean, val verticalFadingEdgeEnabled: Boolean, val fillViewport: Boolean, val scrollbarFadingEnabled: Boolean, val overScrollMode: Int, val fadingEdgeLength: Dimen, @ColorInt val fadingEdgeColor: Int?, val initialScrollPosition: Dimen, val eventsController: VerticalScrollEventsController?, val onScrollChange: (NestedScrollView, scrollY: Int, oldScrollY: Int) -> Unit?, val onInterceptTouch: (NestedScrollView, event: MotionEvent) -> Boolean?, val onScrollStateChange: (View, Int) -> Unit?, val incrementalMountEnabled: Boolean = true, val child: Component, val style: Style?) : PrimitiveComponent

GetLineCountEvent

open class GetLineCountEvent

Use this with TextInput to get the field's current line count.

GetSpanStartEvent

open class GetSpanStartEvent

Return the beginning of the range of text to which the specified markup object is attached.

GetTextEvent

open class GetTextEvent

Use this with TextInput to get the field's current text.

GridLayoutInfo

open class GridLayoutInfo : LayoutInfo

HasPostDispatchDrawListener

interface HasPostDispatchDrawListener

HasStickyHeader

interface HasStickyHeader : ViewportInfo

HideCursorEvent

class HideCursorEvent

Event sent to TextEdit to make cursor invisible.

HorizontalScrollEventsController

open class HorizontalScrollEventsController

A controller that can be passed as com.facebook.litho.annotations.Prop to a to trigger events from outside the component hierarchy.

HorizontalScrollLithoView

open class HorizontalScrollLithoView : HorizontalScrollView, HasLithoViewChildren

Extension of HorizontalScrollView that allows to add more features needed for @.

ImageSpec

object ImageSpec

A component that is able to display drawable resources. It takes a drawable resource ID as prop.

InputConnectionEvent

open class InputConnectionEvent

Event that corresponds to an underlying android.widget.EditText#onCreateInputConnection(EditorInfo editorInfo).

InputFocusChangedEvent

open class InputFocusChangedEvent

Event sent by EditText when the input focus changed by user

ItemDecorationWithMeasureFunction

abstract class ItemDecorationWithMeasureFunction : RecyclerView.ItemDecoration

Creates an ItemDecoration that provides the developer a function to measure the View if the insets required depend on the measured size of the View. The measure function will use the size constraints recorded by Binder of the Recycler Component. This approach is required because the RecyclerView gets the insets from the ItemDecoration before the View is measured, so the measured size of the view is 0, and the insets would not be correct.

KeyPreImeEvent

open class KeyPreImeEvent

Event that corresponds to an underlying android.widget.EditText#onKeyPreIme().

KeyUpEvent

open class KeyUpEvent

Event that corresponds to an underlying android.widget.EditText#onKeyUp().

LayoutHandlerFactory

interface LayoutHandlerFactory

A Factory used to create RunnableHandlers in RecyclerBinder.

LayoutInfo

interface LayoutInfo : ViewportInfo

An implementation of this interface will provide the RecyclerBinder with all the information about the RecyclerView layout.

LayoutInfoUtils

open class LayoutInfoUtils

Utility class for calculating the wrapped height of given holders.

LinearLayoutInfo

open class LinearLayoutInfo : LayoutInfo

An implementation for LayoutInfo to implement linear lists with a .

LithoRecyclerView

open class LithoRecyclerView : RecyclerView, HasPostDispatchDrawListener

Extension of RecyclerView that allows to add more features needed for @

LithoScrollView

open class LithoScrollView : NestedScrollView, HasLithoViewChildren

Extension of NestedScrollView that allows to add more features needed for @.

LithoViewFactory

interface LithoViewFactory

A factory used to create LithoViews in RecyclerBinder.

LongClickableSpan

abstract class LongClickableSpan : ClickableSpan

Extension of ClickableSpan that provides longclick capability in addition to click.

MountableCharSequence

interface MountableCharSequence : CharSequence

Mountable CharSequence that is aware when the Text component using this CharSequence is mounted and unmounted.

NeedsBgPaddingInfo

interface NeedsBgPaddingInfo

Because a LayoutInfo/LayoutManager may rely on padding to generate a child measure specs, and because padding isn't accessible in a thread-safe way, this interface gives a LayoutManager the chance to record the RecyclerView's padding when it's attached.

PostDispatchDrawListener

interface PostDispatchDrawListener

PrimitiveImageLayoutData

class PrimitiveImageLayoutData(val width: Int, val height: Int, val matrix: DrawableMatrix? = null)

The layout data required by the Image Primitive to mount, and bind the drawable in the host.

ProgressPrimitiveComponent

class ProgressPrimitiveComponent(color: Int = Color.TRANSPARENT, indeterminateDrawable: Drawable? = null, style: Style? = null) : PrimitiveComponent

Renders an infinitely spinning progress bar.

ProgressSpec

object ProgressSpec

Renders an infinitely spinning progress bar.

ProgressView

open class ProgressView : ProgressBar

PTRRefreshEvent

open class PTRRefreshEvent

An event that is triggered when a pull-to-refresh action is performed.

Recycler

class Recycler @JvmOverloads constructor(val binder: Binder<RecyclerView>, binderStrategy: PrimitiveRecyclerBinderStrategy? = null, hasFixedSize: Boolean = true, isClipToPaddingEnabled: Boolean = true, leftPadding: Int = 0, topPadding: Int = 0, rightPadding: Int = 0, bottomPadding: Int = 0, @ColorInt refreshProgressBarBackgroundColor: Int? = null, @ColorInt refreshProgressBarColor: Int = Color.BLACK, isClipChildrenEnabled: Boolean = true, isNestedScrollingEnabled: Boolean = true, scrollBarStyle: Int = View.SCROLLBARS_INSIDE_OVERLAY, itemDecorations: List<RecyclerView.ItemDecoration>? = null, isHorizontalFadingEdgeEnabled: Boolean = false, isVerticalFadingEdgeEnabled: Boolean = false, isLeftFadingEnabled: Boolean = true, isRightFadingEnabled: Boolean = true, isTopFadingEnabled: Boolean = true, isBottomFadingEnabled: Boolean = true, fadingEdgeLength: Int = 0, edgeFactory: RecyclerView.EdgeEffectFactory? = null, @IdRes recyclerViewId: Int = View.NO_ID, overScrollMode: Int = View.OVER_SCROLL_ALWAYS, contentDescription: CharSequence? = null, itemAnimator: RecyclerView.ItemAnimator? = NoUpdateItemAnimator(), recyclerEventsController: RecyclerEventsController? = null, onScrollListeners: List<RecyclerView.OnScrollListener>? = null, snapHelper: SnapHelper? = null, isPullToRefreshEnabled: Boolean = true, canMeasureRecycler: Boolean = false, touchInterceptor: LithoRecyclerView.TouchInterceptor? = null, onItemTouchListener: RecyclerView.OnItemTouchListener? = null, onRefresh: () -> Unit? = null, sectionsViewLogger: SectionsRecyclerView.SectionsRecyclerViewLogger? = null, excludeFromIncrementalMount: Boolean = false, paddingAdditionDisabled: Boolean = false, onBeforeLayoutListener: LithoRecyclerView.OnBeforeLayoutListener? = null, onAfterLayoutListener: LithoRecyclerView.OnAfterLayoutListener? = null, style: Style? = null) : PrimitiveComponent

RecyclerBinder

@ThreadSafe

open class RecyclerBinder : Binder<V> , LayoutInfo.RenderInfoCollection, HasStickyHeader

This binder class is used to asynchronously layout Components given a list of Component and attaching them to a Recycler.

RecyclerBinderAdapter

interface RecyclerBinderAdapter

RecyclerBinderAdapterDelegate

interface RecyclerBinderAdapterDelegate<T : RecyclerBinderViewHolder?>

A delegation that is used to customize the adapter behaviour for the RecyclerView that the RecyclerBinder uses.

RecyclerBinderConfig

data class RecyclerBinderConfig(val componentsConfiguration: ComponentsConfiguration? = null, val isCircular: Boolean = false, val lithoViewFactory: LithoViewFactory? = null, val hScrollAsyncMode: Boolean = false, val requestMountForPrefetchedItems: Boolean = false, val recyclerViewItemPrefetch: Boolean = false, val itemViewCacheSize: Int = 0, val componentWarmer: ComponentWarmer? = null, val estimatedViewportCount: Int? = null, val layoutHandlerFactory: LayoutHandlerFactory? = null, val rangeRatio: Float = DEFAULT_RANGE_RATIO, val enableStableIds: Boolean? = null, val wrapContent: Boolean = false, val crossAxisWrapMode: CrossAxisWrapMode = CrossAxisWrapMode.NoWrap, val paginationStrategy: Int = RecyclerBinder.PaginationStrategy.DEFAULT)

This configuration is meant to be used in the context of RecyclerBinder. It allows you to define to define specific behavior changes to the default behaviour of the RecyclerBinder.

RecyclerBinderConfigBuilder

class RecyclerBinderConfigBuilder

This builder is just a helper class for Java clients.

RecyclerBinderException

class RecyclerBinderException @JvmOverloads constructor(message: String, cause: Exception? = null) : RuntimeException

RecyclerBinderOperationExecutor

open class RecyclerBinderOperationExecutor : RecyclerBinderUpdateCallback.OperationExecutor

An implementation of OperationExecutor that uses RecyclerBinder.

RecyclerBinderUpdateCallback

open class RecyclerBinderUpdateCallback<T> : ListUpdateCallback

An implementation of ListUpdateCallback that generates the relevant Components when an item is inserted/updated.

RecyclerBinderViewHolder

abstract class RecyclerBinderViewHolder : RecyclerView.ViewHolder

The ViewHolder that hosts LithoView used by RecyclerBinder

RecyclerEventsController

open class RecyclerEventsController

An controller that can be passed as com.facebook.litho.annotations.Prop to a Recycler component to trigger events from outside the component hierarchy.

RecyclerRangeTraverser

interface RecyclerRangeTraverser

An interface for generating traversing order for a range.

ReMeasureEvent

open class ReMeasureEvent

An event that a RecyclerBinder can trigger to notify the Recycler that it should re-measure.

RemoveSpanEvent

open class RemoveSpanEvent

Remove the specified object from the range of text to which it was attached.

RenderInfo

interface RenderInfo

RenderInfoDebugInfoRegistry

open class RenderInfoDebugInfoRegistry

Holds a mapping of Views inside a Litho hierarchy to related debugging information.

RenderInfoViewCreatorController

open class RenderInfoViewCreatorController

Helper class to keep track of the different view types that we're rendering using ViewRenderInfo.

ReplaceTextEvent

open class ReplaceTextEvent

Replaces the text input text from startIndex to endIndex with the given text.

RequestFocusEvent

open class RequestFocusEvent

Event sent to TextEdit to request focus.

RichText

class RichText(val text: CharSequence, val textStyle: TextStyle? = null, style: Style? = null) : PrimitiveComponent

ScrollStateListener

interface ScrollStateListener

Scroll change listener invoked when the scroll position changes.

SectionsDebug

open class SectionsDebug

Utilities for sections debugging.

SectionsRecyclerView

open class SectionsRecyclerView : SwipeRefreshLayout, HasLithoViewChildren

Wrapper that encapsulates all the features Recycler provides such as sticky header and pull-to-refresh

SelectionChangedEvent

open class SelectionChangedEvent

Event sent by EditText when the selection (particular case: cursor position) gets changed by user

SendAccessibilityEvent

open class SendAccessibilityEvent

Event sent to TextEdit to send accessibility event.

SetSelectionEvent

open class SetSelectionEvent

Use this with TextInput to set the field's current selection.

SetSpanEvent

open class SetSpanEvent

Attach the specified markup object to the range (start, end) of the text, or move the object to that range if it was already attached elsewhere.

SetTextEvent

open class SetTextEvent

Use this with TextInput to set the field's current text.

ShowCursorEvent

class ShowCursorEvent

Event sent to TextEdit to make cursor visible.

SmoothScrollAlignmentType

enum SmoothScrollAlignmentType

SnapUtil

open class SnapUtil

Utility class containing snapping related behavior of RecyclerView.

Spinner

class Spinner @JvmOverloads constructor(options: List<String>, selectedOption: String, onItemSelected: (String) -> Unit, style: Style = Style, @ColorInt selectedTextColor: Int = -0x22000000, selectedTextSize: Float = -1f, caret: Drawable? = null, @LayoutRes itemLayout: Int = android.R.layout.simple_dropdown_item_1line) : KComponent

A simple spinner (dropdown) component. Derived from the standard Android android.widget.Spinner

StaggeredGridLayoutHelper

open class StaggeredGridLayoutHelper

StaggeredGridLayoutInfo

open class StaggeredGridLayoutInfo : LayoutInfo

An implementation for LayoutInfo to implement staggered grids with a .

StartSnapHelper

open class StartSnapHelper : SnapHelper

StickyHeaderController

interface StickyHeaderController

StickyHeaderControllerFactory

interface StickyHeaderControllerFactory

TextAlignment

enum TextAlignment

Enumeration of text alignment values.

TextChangedEvent

open class TextChangedEvent

Event sent by EditText when the text entered by the user changes.

TextDrawable

open class TextDrawable : Drawable, Touchable, TextContent, Drawable.Callback

A Drawable for mounting text content from a Component.

TextOffsetOnTouchEvent

open class TextOffsetOnTouchEvent

Text component should implement an event of this type in order to receive callback on what was the text offset when text was touched initially.

TextPastedEvent

open class TextPastedEvent

Event sent by EditText when the text entered is pasted from clipboard.

TextSpec

@MountSpec(isPureRender = true, poolSize = 30, canPreallocate = true, events = [TextOffsetOnTouchEvent::class])

open class TextSpec

Component to render text.

TextStylesHelper

class TextStylesHelper

TextureWarmer

open class TextureWarmer

A class that schedules a background draw of a Layout or Drawable.

TouchableFeedback

class TouchableFeedback(content: Component, @ColorInt color: Int = Color.WHITE, @ColorInt highlightColor: Int = Color.LTGRAY) : KComponent

A Component that can wrap another component to add touch feedback via a RippleDrawable background.

TouchableSpanListener

interface TouchableSpanListener

A listener that reacts to touch events on a clickable span.

TransparencyEnabledCardClipDrawable

open class TransparencyEnabledCardClipDrawable : Drawable

TreePropsWrappedRenderInfo

open class TreePropsWrappedRenderInfo : RenderInfo

A wrapper around RenderInfo that also stores TreeProps used for rendering the component.

VerticalGravity

enum VerticalGravity : Enum<VerticalGravity>

Enum for setting vertical gravity of a component. Currently used to design where to vertically align text in a text component.

VerticalScrollComponentSpec

@MountSpec(hasChildLithoViews = true, isPureRender = true)

open class VerticalScrollComponentSpec

Component that wraps another component, allowing it to be vertically scrollable.

VerticalScrollEventsController

open class VerticalScrollEventsController

A controller that can be passed as com.facebook.litho.annotations.Prop to a to trigger events from outside the component hierarchy.

VerticalScrollSpec

object VerticalScrollSpec

ViewportInfo

interface ViewportInfo

An implementation of this interface will provide both the 's current visible views position and the total number of items in its androidx.recyclerview.widget.RecyclerView.Adapter.

ViewRenderInfo

open class ViewRenderInfo : BaseRenderInfo

RenderInfo that can render views.

WidgetAttributes

open class WidgetAttributes

Collection of the AttributeKey that are used across Litho's widgets.