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

IndicatorBox

@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.

Parameters

state

the state of this modifier, will use state.distanceFraction and maxDistance to calculate the offset

isRefreshing

whether a refresh is occurring

modifier

the modifier applied to this layout

maxDistance

the max distance the indicator can be pulled down before a refresh is triggered on release

shape

the Shape of this indicator

containerColor

the container color of this indicator

elevation

the elevation for the indicator

content

content for this IndicatorBox