Package-level declarations

Types

Link copied to clipboard
value class Visibility

Functions

Link copied to clipboard
inline fun Style.onFocusedVisible(noinline onFocused: (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.

Link copied to clipboard
inline fun Style.onFullImpression(noinline onFullImpression: (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:

Link copied to clipboard
inline fun Style.onInvisible(noinline onInvisible: (InvisibleEvent) -> Unit): Style

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

Link copied to clipboard
inline fun Style.onUnfocusedVisible(noinline onUnfocused: (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.

Link copied to clipboard
inline fun Style.onVisibilityChanged(noinline onVisibilityChanged: (VisibilityChangedEvent) -> Unit): Style

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

Link copied to clipboard
inline fun Style.onVisible(noinline onVisible: (VisibleEvent) -> Unit): Style

Registers a callback to be called when any part of the Component becomes visible on screen.

Link copied to clipboard
inline fun Style.onVisibleWithTag(tag: String?, noinline onVisible: (VisibleEvent) -> Unit): Style
Link copied to clipboard

Defines the visibility of the Component. The values can be Visibility.VISIBLE or Visibility.INVISIBLE. The default value Visibility.VISIBLE which means is the same as View.VISIBLE; i.e. the component will be invisible but still occupy space. Note: Using this API will not change how Visibility Events are dispatched; onVisible and/or onInvisible will work as if this property was not in use.

Link copied to clipboard
inline fun Style.visibleHeightRatio(visibleHeightRatio: Float): Style

Defines a ratio of the Component height for the visibility callback to be dispatched use together with onVisible and/or with onInvisible.

Link copied to clipboard
inline fun Style.visibleWidthRatio(visibleWidthRatio: Float): Style

Defines a ratio of the Component width for the visibility callback to be dispatched use together with onVisible and/or with onInvisible.