← Back to Material Compose
PullRefreshIndicator
Component
in
Material
. Since 1.3.0Overview
Code Examples
The default indicator for Compose pull-to-refresh, based on Android's SwipeRefreshLayout.
Overloads
PullRefreshIndicator
@Composable
@ExperimentalMaterialApi
// enable people to use this indicator with custom pull-to-refresh components.
fun PullRefreshIndicator(
refreshing: Boolean,
state: PullRefreshState,
modifier: Modifier = Modifier,
backgroundColor: Color = MaterialTheme.colors.surface,
contentColor: Color = contentColorFor(backgroundColor),
scale: Boolean = false
)
Parameters
Name | Description |
---|---|
refreshing | A boolean representing whether a refresh is occurring. |
state | The PullRefreshState which controls where and how the indicator will be drawn. |
modifier | Modifiers for the indicator. |
backgroundColor | The color of the indicator's background. |
contentColor | The color of the indicator's arc and arrow. |
scale | A boolean controlling whether the indicator's size scales with pull progress or not |