# PullToRefreshDefaults

Artifact: [androidx.wear.compose:compose-material3](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material3/PullToRefresh.kt+class:androidx.wear.compose.material3.PullToRefreshDefaults) Added in [1.8.0-alpha03](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.8.0-alpha03)


```
object PullToRefreshDefaults
```

<br />

*** ** * ** ***

Contains the default values for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshBox.composable#PullToRefreshBox(kotlin.Boolean,kotlin.Function0,androidx.wear.compose.material3.PullToRefreshState,androidx.compose.ui.Modifier,androidx.compose.ui.Alignment,kotlin.Function1,kotlin.Boolean,androidx.compose.ui.unit.Dp,kotlin.Function1)`

## Summary

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)( state: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshState, isRefreshing: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier, containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, colors: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ProgressIndicatorColors, maxDistance: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp )` The default indicator for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshBox.composable#PullToRefreshBox(kotlin.Boolean,kotlin.Function0,androidx.wear.compose.material3.PullToRefreshState,androidx.compose.ui.Modifier,androidx.compose.ui.Alignment,kotlin.Function1,kotlin.Boolean,androidx.compose.ui.unit.Dp,kotlin.Function1)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#IndicatorBox(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,kotlin.Function1)( state: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshState, isRefreshing: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier, maxDistance: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp, shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape, containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/BoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` A Wrapper that handles the size, offset, clipping and background drawing for a pull-to-refresh indicator, useful when implementing custom indicators. |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#IndicatorMaxDistance()` The default maximum travel distance for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#IndicatorBox(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,kotlin.Function1)` to clear the top screen curvature and avoid colliding with `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.CurvedModifier,kotlin.Float,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.TimeSource,androidx.compose.foundation.layout.PaddingValues,kotlin.Function2)` during refresh. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#IndicatorShape()` The default shape for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)` |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#PositionalThreshold()` The default drag distance to trigger a refresh, tailored for compact watch displays. |
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ProgressIndicatorColors` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#indicatorColors()` The default indicator colors for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)` |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#indicatorContainerColor()` The default container color for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)` |

## Public functions

### Indicator

Added in [1.8.0-alpha03](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.8.0-alpha03)

```
@Composable
fun Indicator(
    state: PullToRefreshState,
    isRefreshing: Boolean,
    modifier: Modifier = Modifier,
    containerColor: Color = this.indicatorContainerColor,
    colors: ProgressIndicatorColors = this.indicatorColors,
    maxDistance: Dp = IndicatorMaxDistance
): Unit
```

The default indicator for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshBox.composable#PullToRefreshBox(kotlin.Boolean,kotlin.Function0,androidx.wear.compose.material3.PullToRefreshState,androidx.compose.ui.Modifier,androidx.compose.ui.Alignment,kotlin.Function1,kotlin.Boolean,androidx.compose.ui.unit.Dp,kotlin.Function1)`. This component draws a circular arrow based on `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshState#distanceFraction()`, and crossfades into a `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/CircularProgressIndicator.composable#CircularProgressIndicator(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Boolean,kotlin.Float,kotlin.Float,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp)` when the refresh triggers.

| Parameters |
|---|---|
| `state: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshState` | the state that keeps track of distance pulled, will use `state.distanceFraction` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)` to calculate the offset |
| `isRefreshing: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | whether a refresh is occurring |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | the modifier applied to this layout |
| `containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = this.indicatorContainerColor` | the container color of this indicator |
| `colors: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ProgressIndicatorColors = this.indicatorColors` | the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ProgressIndicatorColors` used to resolve indicator and track colors |
| `maxDistance: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = IndicatorMaxDistance` | the max distance the indicator can be pulled down before a refresh is triggered on release |

### IndicatorBox

```
@Composable
fun IndicatorBox(
    state: PullToRefreshState,
    isRefreshing: Boolean,
    modifier: Modifier = Modifier,
    maxDistance: Dp = IndicatorMaxDistance,
    shape: Shape = IndicatorShape,
    containerColor: Color = indicatorContainerColor,
    content: @Composable BoxScope.() -> Unit
): Unit
```

A Wrapper that handles the size, offset, clipping and background drawing for a pull-to-refresh indicator, useful when implementing custom indicators. `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)` uses this as the container.

| Parameters |
|---|---|
| `state: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshState` | the state that keeps track of distance pulled, will use `state.distanceFraction` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#IndicatorBox(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,kotlin.Function1)` to calculate the offset |
| `isRefreshing: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | whether a refresh is occurring |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | the modifier applied to this layout |
| `maxDistance: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = IndicatorMaxDistance` | the max distance the indicator can be pulled down before a refresh is triggered on release |
| `shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = IndicatorShape` | the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` of this indicator |
| `containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = indicatorContainerColor` | the container color of this indicator |
| `content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/BoxScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | content for this `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#IndicatorBox(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,kotlin.Function1)` |

## Public properties

### IndicatorMaxDistance

```
val IndicatorMaxDistance: Dp
```

The default maximum travel distance for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#IndicatorBox(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,kotlin.Function1)` to clear the top screen curvature and avoid colliding with `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.CurvedModifier,kotlin.Float,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.TimeSource,androidx.compose.foundation.layout.PaddingValues,kotlin.Function2)` during refresh.

### IndicatorShape

Added in [1.8.0-alpha03](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.8.0-alpha03)

```
val IndicatorShape: Shape
```

The default shape for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)`

### PositionalThreshold

```
val PositionalThreshold: Dp
```

The default drag distance to trigger a refresh, tailored for compact watch displays.

### indicatorColors

```
val indicatorColors: ProgressIndicatorColors
```

The default indicator colors for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)`

### indicatorContainerColor

```
val indicatorContainerColor: Color
```

The default container color for `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/PullToRefreshDefaults#Indicator(androidx.wear.compose.material3.PullToRefreshState,kotlin.Boolean,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.ProgressIndicatorColors,androidx.compose.ui.unit.Dp)`