# ScrollFieldDefaults

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/ScrollField.kt+class:androidx.compose.material3.ScrollFieldDefaults) Common/AllAndroid/JVM
- Cmn

  ```
  object ScrollFieldDefaults
  ```

*** ** * ** ***

Object to hold defaults used by `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`.

## 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/compose/material3/ScrollFieldDefaults#Item(kotlin.Int,kotlin.Boolean,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors)( index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, selected: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, colors: https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldColors )` The default item implementation for `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldDefaults#colors()()` Default colors used by a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldDefaults#colors(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)( containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, selectedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledSelectedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldColors` that represents the default container, content, and selected colors used in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`. | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldDefaults#ScrollFieldHeight()` The default height for a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldDefaults#shape()` The default shape for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)` container background. | Cmn |

## Public functions

### Item

Cmn

```
@Composable
fun Item(
    index: Int,
    selected: Boolean,
    enabled: Boolean = true,
    colors: ScrollFieldColors = colors()
): Unit
```

The default item implementation for `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`.

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | the current item index. |
| `selected: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | whether this item is currently selected (centered). |
| `enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | whether this item is currently enabled. |
| `colors: https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldColors = colors()` | the colors to use for the text content. |

### colors

Cmn

```
@Composable
fun colors(): ScrollFieldColors
```

Default colors used by a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`.

### colors

Cmn

```
@Composable
fun colors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = Color.Unspecified,
    selectedContentColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSelectedContentColor: Color = Color.Unspecified
): ScrollFieldColors
```

Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollFieldColors` that represents the default container, content, and selected colors used in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`.

| Parameters |
|---|---|
| `containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The color of the `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)` container, when enabled. |
| `contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The color of the numerical value(s) visible on the screen that are not chosen, when enabled. |
| `selectedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The color of the numerical value that is centered and snapped into place, when enabled. |
| `disabledContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The color of the `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)` container, when disabled. |
| `disabledContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The color of the numerical value(s) visible on the screen that are not chosen, when disabled. |
| `disabledSelectedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = Color.Unspecified` | The color of the numerical value that is centered and snapped into place, when disabled. |

## Public properties

### ScrollFieldHeight

Cmn

```
val ScrollFieldHeight: Dp
```

The default height for a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)`. This can be used as a reference when providing a Modifier.height to the ScrollField to ensure enough vertical space is available to display the typical three-item layout.

### shape

Cmn

```
val shape: Shape
```

The default shape for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/ScrollField.composable#ScrollField(androidx.compose.material3.ScrollFieldState,kotlin.String,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.ScrollFieldColors,kotlin.Function1,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function3)` container background.