<div class='sourceset sourceset-android'>Android</div>

```kotlin
public object ButtonDefaults
```

Contains the default values used by [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button)

## Functions

<h2 id="filledtonalbuttoncolors">filledTonalButtonColors</h2>

```kotlin
@Composable
public fun filledTonalButtonColors(): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) with a muted background and contrasting content color, the defaults
for medium emphasis buttons like [FilledTonalButton](/jetpack-compose/androidx.wear.compose/compose-material3/components/FilledTonalButton). Use [filledTonalButtonColors](#filledtonalbuttoncolors) for
important actions that don't distract from other onscreen elements, such as final or
unblocking actions in a flow with less emphasis than [buttonColors](/jetpack-compose/androidx.wear.compose/compose-material/interfaces/ButtonColors).

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have alpha (`DisabledContainerAlpha`) value applied.

<hr class="docs-overload-divider">

<h2 id="filledtonalbuttoncolors-containercolor-contentcolor-secondarycontentcolor-iconcolor-disabledcontainercolor-disabledcontentcolor-disabledsecondarycontentcolor-disablediconcolor">filledTonalButtonColors</h2>

```kotlin
@Composable
public fun filledTonalButtonColors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) with a muted background and contrasting content color, the defaults
for medium emphasis buttons like [FilledTonalButton](/jetpack-compose/androidx.wear.compose/compose-material3/components/FilledTonalButton). Use [filledTonalButtonColors](#filledtonalbuttoncolors) for
important actions that don't distract from other onscreen elements, such as final or
unblocking actions in a flow with less emphasis than [buttonColors](/jetpack-compose/androidx.wear.compose/compose-material/interfaces/ButtonColors).

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have alpha (`DisabledContainerAlpha`) value applied.

#### Parameters

| | |
| --- | --- |
| containerColor | The background color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| contentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| secondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for secondaryLabel content |
| iconColor | The icon color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for icon content |
| disabledContainerColor | The background color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledSecondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledIconColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |

<hr class="docs-overload-divider">

<h2 id="filledvariantbuttoncolors">filledVariantButtonColors</h2>

```kotlin
@Composable
public fun filledVariantButtonColors(): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) as an alternative to the [filledTonalButtonColors](#filledtonalbuttoncolors), giving a surface
with more chroma to indicate selected or highlighted states that are not primary
calls-to-action. If the icon button is disabled then the colors will default to the
MaterialTheme onSurface color with suitable alpha values applied.

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have alpha (`DisabledContainerAlpha`) value applied.

Example of a [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) with [filledVariantButtonColors](#filledvariantbuttoncolors):

<hr class="docs-overload-divider">

<h2 id="filledvariantbuttoncolors-containercolor-contentcolor-secondarycontentcolor-iconcolor-disabledcontainercolor-disabledcontentcolor-disabledsecondarycontentcolor-disablediconcolor">filledVariantButtonColors</h2>

```kotlin
@Composable
public fun filledVariantButtonColors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) as an alternative to the [filledTonalButtonColors](#filledtonalbuttoncolors), giving a surface
with more chroma to indicate selected or highlighted states that are not primary
calls-to-action. If the icon button is disabled then the colors will default to the
MaterialTheme onSurface color with suitable alpha values applied.

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have alpha (`DisabledContainerAlpha`) value applied.

Example of a [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) with [filledVariantButtonColors](#filledvariantbuttoncolors):

#### Parameters

| | |
| --- | --- |
| containerColor | The background color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| contentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| secondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for secondaryLabel content |
| iconColor | The icon color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for icon content |
| disabledContainerColor | The background color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledSecondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledIconColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |

<hr class="docs-overload-divider">

<h2 id="outlinedbuttoncolors">outlinedButtonColors</h2>

```kotlin
@Composable
public fun outlinedButtonColors(): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) with a transparent background (typically paired with
[ButtonDefaults.outlinedButtonBorder](/jetpack-compose/androidx.wear.compose/compose-material3/objects/ButtonDefaults)), the defaults for medium emphasis buttons like
[OutlinedButton](/jetpack-compose/androidx.wear.compose/compose-material3/components/OutlinedButton), for important, non-primary actions that need attention.

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have an alpha(`DisabledContainerAlpha`) applied.

<hr class="docs-overload-divider">

<h2 id="outlinedbuttoncolors-contentcolor-secondarycontentcolor-iconcolor-disabledcontentcolor-disabledsecondarycontentcolor-disablediconcolor">outlinedButtonColors</h2>

```kotlin
@Composable
public fun outlinedButtonColors(
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) with a transparent background (typically paired with
[ButtonDefaults.outlinedButtonBorder](/jetpack-compose/androidx.wear.compose/compose-material3/objects/ButtonDefaults)), the defaults for medium emphasis buttons like
[OutlinedButton](/jetpack-compose/androidx.wear.compose/compose-material3/components/OutlinedButton), for important, non-primary actions that need attention.

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have an alpha(`DisabledContainerAlpha`) applied.

#### Parameters

| | |
| --- | --- |
| contentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| secondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for secondaryLabel content |
| iconColor | The icon color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for icon content |
| disabledContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledSecondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledIconColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |

<hr class="docs-overload-divider">

<h2 id="childbuttoncolors">childButtonColors</h2>

```kotlin
@Composable
public fun childButtonColors(): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) with transparent background, the defaults for low emphasis buttons
like [ChildButton](/jetpack-compose/androidx.wear.compose/compose-material3/components/ChildButton). Use [childButtonColors](#childbuttoncolors) for optional or supplementary actions with the
least amount of prominence.

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have an alpha(`DisabledContainerAlpha`) value applied.

<hr class="docs-overload-divider">

<h2 id="childbuttoncolors-contentcolor-secondarycontentcolor-iconcolor-disabledcontentcolor-disabledsecondarycontentcolor-disablediconcolor">childButtonColors</h2>

```kotlin
@Composable
public fun childButtonColors(
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) with transparent background, the defaults for low emphasis buttons
like [ChildButton](/jetpack-compose/androidx.wear.compose/compose-material3/components/ChildButton). Use [childButtonColors](#childbuttoncolors) for optional or supplementary actions with the
least amount of prominence.

If a button is disabled then the content will have an alpha(`DisabledContentAlpha`) value
applied and container will have an alpha(`DisabledContainerAlpha`) value applied.

#### Parameters

| | |
| --- | --- |
| contentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| secondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for secondaryLabel content |
| iconColor | The icon color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for icon content |
| disabledContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledSecondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledIconColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |

<hr class="docs-overload-divider">

<h2 id="buttonwithcontainerpaintercolors">buttonWithContainerPainterColors</h2>

```kotlin
@Composable
public fun buttonWithContainerPainterColors(): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) for the content in a [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) with an image container painter.

<hr class="docs-overload-divider">

<h2 id="buttonwithcontainerpaintercolors-contentcolor-secondarycontentcolor-iconcolor-disabledcontentcolor-disabledsecondarycontentcolor-disablediconcolor">buttonWithContainerPainterColors</h2>

```kotlin
@Composable
public fun buttonWithContainerPainterColors(
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) for the content in a [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) with an image container painter.

Example of a Button with an image background:

#### Parameters

| | |
| --- | --- |
| contentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| secondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for secondaryLabel content |
| iconColor | The icon color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled, used for icon content |
| disabledContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when disabled |
| disabledSecondaryContentColor | The secondary content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when disabled, used for secondary label content |
| disabledIconColor | The icon color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when disabled, used for icon content |

<hr class="docs-overload-divider">

<h2 id="containerpainter-image-scrim-sizetointrinsics-alignment-contentscale-alpha">containerPainter</h2>

```kotlin
@Composable
public fun containerPainter(
    image: Painter,
    scrim: Brush? = scrimBrush(),
    sizeToIntrinsics: Boolean = false,
    alignment: Alignment = Alignment.Center,
    contentScale: ContentScale = ContentScale.Fit,
    alpha: Float = DefaultAlpha,
): Painter
```

Creates a [Painter](/jetpack-compose/androidx.compose.ui/ui-graphics/classes/Painter) for the background of a [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) with container painter, that displays an
image with a scrim on top to make sure that any content above the background will be legible.

An Image background is a means to reinforce the meaning of information in a Button. Buttons
should have a content color that contrasts with the background image and scrim.

Example of a Button with an image background:

#### Parameters

| | |
| --- | --- |
| image | The [Painter](/jetpack-compose/androidx.compose.ui/ui-graphics/classes/Painter) to use to draw the container background of the [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button). |
| scrim | The [Brush](/jetpack-compose/androidx.compose.ui/ui-graphics/classes/Brush) to use to paint a scrim over the container image to ensure that any text drawn over the image is legible. |
| sizeToIntrinsics | When false (the default), fills the available space within the container. Pass true to retain the size of the image. |
| alignment | Specifies alignment of the container image painter relative to the container. |
| contentScale | Strategy for scaling the painter if its size does not match the container. |
| alpha | Opacity of the container image painter and scrim. |

<hr class="docs-overload-divider">

<h2 id="disabledcontainerpainter-containerpainter">disabledContainerPainter</h2>

```kotlin
public fun disabledContainerPainter(containerPainter: Painter): Painter
```

Creates a [Painter](/jetpack-compose/androidx.compose.ui/ui-graphics/classes/Painter) for the disabled background of a [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) with container painter - draws
the containerPainter with an alpha applied to achieve a disabled effect.

An Image background is a means to reinforce the meaning of information in a Button. Buttons
should have a content color that contrasts with the background image and scrim.

#### Parameters

| | |
| --- | --- |
| containerPainter | The [Painter](/jetpack-compose/androidx.compose.ui/ui-graphics/classes/Painter) to use to draw the container background of the [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled. An alpha will be applied to this to achieve a disabled effect. |

<hr class="docs-overload-divider">

<h2 id="scrimbrush">scrimBrush</h2>

```kotlin
@Composable
public fun scrimBrush(): Brush
```

Creates a [Brush](/jetpack-compose/androidx.compose.ui/ui-graphics/classes/Brush) for the recommended scrim drawn on top of image container backgrounds.

<hr class="docs-overload-divider">

<h2 id="outlinedbuttonborder-enabled-bordercolor-disabledbordercolor-borderwidth">outlinedButtonBorder</h2>

```kotlin
@Composable
public fun outlinedButtonBorder(
    enabled: Boolean,
    borderColor: Color = OutlinedButtonTokens.ContainerBorderColor.value,
    disabledBorderColor: Color =
        OutlinedButtonTokens.DisabledContainerBorderColor.value.toDisabledColor(
            disabledAlpha = OutlinedButtonTokens.DisabledContainerBorderOpacity
        ),
    borderWidth: Dp = OutlinedButtonTokens.ContainerBorderWidth,
): BorderStroke
```

Creates a [BorderStroke](/jetpack-compose/androidx.compose.foundation/foundation/classes/BorderStroke), such as for an [OutlinedButton](/jetpack-compose/androidx.wear.compose/compose-material3/components/OutlinedButton)

#### Parameters

| | |
| --- | --- |
| enabled | Controls the color of the border based on the enabled/disabled state of the button |
| borderColor | The color to use for the border for this outline when enabled |
| disabledBorderColor | The color to use for the border for this outline when disabled |
| borderWidth | The width to use for the border for this outline. It is strongly recommended to use the default width as this outline is a key characteristic of Wear Material3. |

<hr class="docs-overload-divider">

<h2 id="buttoncolors">buttonColors</h2>

```kotlin
@Composable
public fun buttonColors(): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) that represents the default background and content colors used in a
[Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button).

<hr class="docs-overload-divider">

<h2 id="buttoncolors-containercolor-contentcolor-secondarycontentcolor-iconcolor-disabledcontainercolor-disabledcontentcolor-disabledsecondarycontentcolor-disablediconcolor">buttonColors</h2>

```kotlin
@Composable
public fun buttonColors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors
```

Creates a [ButtonColors](/jetpack-compose/androidx.wear.compose/compose-material3/classes/ButtonColors) that represents the default background and content colors used in a
[Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button).

#### Parameters

| | |
| --- | --- |
| containerColor | The background color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| contentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| secondaryContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| iconColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when enabled |
| disabledContainerColor | The background color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledSecondaryContentColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |
| disabledIconColor | The content color of this [Button](/jetpack-compose/androidx.wear.compose/compose-material3/components/Button) when not enabled |