Compose Multiplatform Material3/androidx.compose.material3.pulltorefresh/PullToRefreshDefaults

PullToRefreshDefaults

object PullToRefreshDefaults

Contains the default values for PullToRefreshBox

Properties

Link copied to clipboard
@get:Composable
val containerColor: Color

The default container color for Indicator

Link copied to clipboard
val Elevation: Dp

The default elevation for an IndicatorBox that is applied to an Indicator

Link copied to clipboard
@get:Composable
val indicatorColor: Color

The default indicator color for Indicator

Link copied to clipboard
@get:Composable
val indicatorContainerColor: Color

The default container color for Indicator

Link copied to clipboard
val IndicatorMaxDistance: Dp

The default maximum distance Indicator, IndicatorBox and LoadingIndicator can be pulled before a refresh is triggered.

Link copied to clipboard
val indicatorShape: Shape

The default shape for Indicator

Link copied to clipboard
@get:Composable
val loadingIndicatorColor: Color

The default active indicator color for the loading indicator that appears when pulling to refresh.

Link copied to clipboard
@get:Composable
val loadingIndicatorContainerColor: Color

The default container color for the loading indicator that appears when pulling to refresh.

Link copied to clipboard
val LoadingIndicatorElevation: Dp

The default elevation for an IndicatorBox that is applied to a LoadingIndicator

Link copied to clipboard
val PositionalThreshold: Dp

The default refresh threshold for rememberPullToRefreshState

Link copied to clipboard
val shape: Shape

The default shape for Indicator

Functions

Link copied to clipboard
@Composable
fun Indicator(state: PullToRefreshState, isRefreshing: Boolean, modifier: Modifier = Modifier, containerColor: Color = this.indicatorContainerColor, color: Color = this.indicatorColor, maxDistance: Dp = IndicatorMaxDistance)

The default indicator for PullToRefreshBox.

Link copied to clipboard
@Composable
fun IndicatorBox(state: PullToRefreshState, isRefreshing: Boolean, modifier: Modifier = Modifier, maxDistance: Dp = IndicatorMaxDistance, shape: Shape = indicatorShape, containerColor: Color = Color.Unspecified, elevation: Dp = Elevation, content: @Composable BoxScope.() -> Unit)

A Wrapper that handles the size, offset, clipping, shadow, and background drawing for a pull-to-refresh indicator, useful when implementing custom indicators. PullToRefreshDefaults.Indicator uses this as the container.

Link copied to clipboard
@Composable
fun LoadingIndicator(state: PullToRefreshState, isRefreshing: Boolean, modifier: Modifier = Modifier, containerColor: Color = this.loadingIndicatorContainerColor, color: Color = this.loadingIndicatorColor, elevation: Dp = LoadingIndicatorElevation, maxDistance: Dp = IndicatorMaxDistance)

A LoadingIndicator indicator for PullToRefreshBox.