litho-core/com.facebook.litho.visibility

Package-level declarations

Types

The visibility of a Component, mirroring View.VISIBLE and View.INVISIBLE.

Functions

fun Style.onFocusedVisible(visibleWidthRatio: Float = 0.0f, visibleHeightRatio: Float = 0.0f, callback: (FocusedVisibleEvent) -> Unit): Style

Registers a callback to be called when either the Component occupies at least half of the viewport, or, if the Component is smaller than half the viewport, when it is fully visible.

onFullImpression

fun Style.onFullImpression(visibleWidthRatio: Float = 0.0f, visibleHeightRatio: Float = 0.0f, callback: (FullImpressionVisibleEvent) -> Unit): Style

Registers a callback to be called when all parts of a Component have been made visible at some point, termed a "full impression". A full impression is defined as:

onInvisible

fun Style.onInvisible(visibleWidthRatio: Float = 0.0f, visibleHeightRatio: Float = 0.0f, callback: (InvisibleEvent) -> Unit): Style

Registers a callback to be called when a Component becomes fully invisible (e.g. scrolled off or unmounted).

onUnfocusedVisible

fun Style.onUnfocusedVisible(visibleWidthRatio: Float = 0.0f, visibleHeightRatio: Float = 0.0f, callback: (UnfocusedVisibleEvent) -> Unit): Style

Registers a callback to be called when the Component is no longer focused, i.e. it is not fully visible and does not occupy at least half the viewport.

onVisibilityChanged

fun Style.onVisibilityChanged(visibleWidthRatio: Float = 0.0f, visibleHeightRatio: Float = 0.0f, callback: (VisibilityChangedEvent) -> Unit): Style

Registers a callback to be called when the visible rect of a Component changes.

onVisible

fun Style.onVisible(visibleWidthRatio: Float = 0.0f, visibleHeightRatio: Float = 0.0f, callback: (VisibleEvent) -> Unit): Style

Registers a callback to be called when a Component becomes visible on screen.

onVisibleWithTag

fun Style.~~onVisibleWithTag~~(visibleWidthRatio: Float = 0.0f, visibleHeightRatio: Float = 0.0f, tag: () -> String?, callback: (VisibleEvent) -> Unit): Style

Registers a callback to be called when a Component becomes visible on screen, with a tag for identification.

visibility

@ExperimentalLithoApi

fun Style.visibility(value: Visibility): Style

Defines the visibility of the Component. The value can be Visibility.Visible or Visibility.Invisible; the default is Visibility.Visible.