Composable Function

rememberPullRefreshState

Creates a PullRefreshState that is remembered across compositions.

rememberPullRefreshState

Source set: Common
@Composable
@ExperimentalMaterialApi
fun rememberPullRefreshState(
    refreshing: Boolean,
    onRefresh: () -> Unit,
    refreshThreshold: Dp = PullRefreshDefaults.RefreshThreshold,
    refreshingOffset: Dp = PullRefreshDefaults.RefreshingOffset,
): PullRefreshState

Creates a PullRefreshState that is remembered across compositions.

Changes to refreshing will result in PullRefreshState being updated.

Parameters

refreshing A boolean representing whether a refresh is currently occurring.
onRefresh The function to be called to trigger a refresh.
refreshThreshold The threshold below which, if a release occurs, onRefresh will be called.
refreshingOffset The offset at which the indicator will be drawn while refreshing. This offset corresponds to the position of the bottom of the indicator.

Last updated: