← Back to Material 3 Compose
PullToRefreshContainer
Component
in
Material 3
. Since 1.2.0-alpha11Overview
Code Examples
Material Design pull-to-refresh indicator
A pull-to-refresh container contains a progress indicator to indicate a users drag progress towards triggering a refresh. On a refresh the progress indicator inside this container is indeterminate.
Overloads
PullToRefreshContainer
@Composable
@ExperimentalMaterial3Api
@Suppress("ComposableLambdaParameterPosition")
fun PullToRefreshContainer(
state: PullToRefreshState,
modifier: Modifier = Modifier,
indicator: @Composable (PullToRefreshState) -> Unit = { pullRefreshState ->
Indicator(state = pullRefreshState)
},
shape: Shape = PullToRefreshDefaults.shape,
containerColor: Color = PullToRefreshDefaults.containerColor,
contentColor: Color = PullToRefreshDefaults.contentColor,
)
Parameters
Name | Description |
---|---|
state | the state of this PullToRefreshContainer |
modifier | the Modifier to be applied to this container |
indicator | The indicator placed inside of the PullToRefreshContainer. Has access to state |
shape | the Shape of this container |
containerColor | the color of this container |
contentColor | the color of the progress indicato |