pullToRefresh

Functions summary

Modifier

Modifier.pullToRefresh(
    isRefreshing: Boolean,
    state: PullToRefreshState,
    enabled: Boolean,
    threshold: Dp,
    onRefresh: () -> Unit
)

A Modifier that adds nested scroll to a container to support a pull-to-refresh gesture.

Cmn

Functions

Modifier.pullToRefresh

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha16

fun Modifier.pullToRefresh(
    isRefreshing: Boolean,
    state: PullToRefreshState,
    enabled: Boolean = true,
    threshold: Dp = PullToRefreshDefaults.PositionalThreshold,
    onRefresh: () -> Unit
): Modifier

A Modifier that adds nested scroll to a container to support a pull-to-refresh gesture. When the user pulls a distance greater than threshold and releases the gesture, onRefresh is invoked. PullToRefreshBox applies this automatically.

Parameters
`isRefreshing: Boolean`	whether a refresh is occurring or not, if there is no gesture in progress when isRefreshing is false the `state.distanceFraction` will animate to 0f, otherwise it will animate to 1f
`state: PullToRefreshState`	state that keeps track of the distance pulled
`enabled: Boolean = true`	whether nested scroll events should be consumed by this modifier
`threshold: Dp = PullToRefreshDefaults.PositionalThreshold`	how much distance can be scrolled down before `onRefresh` is invoked
`onRefresh: () -> Unit`	callback that is invoked when the distance pulled is greater than `threshold`