# WideButtonDefaults Artifact: [androidx.tv:tv-material](https://developer.android.com/jetpack/androidx/releases/tv) [View Source](https://cs.android.com/search?q=file:androidx/tv/material3/WideButtonDefaults.kt+class:androidx.tv.material3.WideButtonDefaults) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0) ``` object WideButtonDefaults ```
*** ** * ** *** ## 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/tv/material3/WideButtonDefaults#Background(kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource)(enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, interactionSource: https://developer.android.com/reference/kotlin/androidx/compose/foundation/interaction/MutableInteractionSource)` Default background for a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` | | `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonBorder` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonDefaults#border(androidx.tv.material3.Border,androidx.tv.material3.Border,androidx.tv.material3.Border,androidx.tv.material3.Border,androidx.tv.material3.Border)( border: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border, focusedBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border, pressedBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border, disabledBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border, focusedDisabledBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border )` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonBorder` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border`s applied on a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` in different `https://developer.android.com/reference/kotlin/androidx/compose/foundation/interaction/Interaction` states | | `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonContentColor` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonDefaults#contentColor(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)( color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, focusedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, pressedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonContentColor` that represents the default content colors used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` | | `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonGlow` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonDefaults#glow(androidx.tv.material3.Glow,androidx.tv.material3.Glow,androidx.tv.material3.Glow)(glow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow, focusedGlow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow, pressedGlow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow)` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonGlow` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow`s used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` | | `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonScale` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonDefaults#scale(kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)( scale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, focusedScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, pressedScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, disabledScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, focusedDisabledScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html )` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonScale` that represents the default scales used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)`. | | `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonShape` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonDefaults#shape(androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape)( shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape, focusedShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape, pressedShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape, disabledShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape, focusedDisabledShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape )` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonShape` that represents the default container shapes used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` | ## Public functions ### Background Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0) ``` @Composable fun Background(enabled: Boolean, interactionSource: MutableInteractionSource): Unit ``` Default background for a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` ### border Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0) ``` @Composable fun border(     border: Border = Border.None,     focusedBorder: Border = border,     pressedBorder: Border = focusedBorder,     disabledBorder: Border = border,     focusedDisabledBorder: Border = Border( border = BorderStroke(width = 2.dp, color = MaterialTheme.colorScheme.border), inset = 0.dp, shape = ContainerShape, ) ): ButtonBorder ``` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonBorder` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border`s applied on a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` in different `https://developer.android.com/reference/kotlin/androidx/compose/foundation/interaction/Interaction` states | Parameters | |---|---| | `border: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border = Border.None` | the `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` to be used for this Button when enabled | | `focusedBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border = border` | the `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` to be used for this Button when focused | | `pressedBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border = focusedBorder` | the `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` to be used for this Button when pressed | | `disabledBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border = border` | the `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` to be used for this Button when disabled | | `focusedDisabledBorder: https://developer.android.com/reference/kotlin/androidx/tv/material3/Border = Border( border = BorderStroke(width = 2.dp, color = MaterialTheme.colorScheme.border), inset = 0.dp, shape = ContainerShape, )` | the `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` to be used for this Button when disabled and focused | ### contentColor Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tv#1.1.0) ``` @Composable fun contentColor(     color: Color = MaterialTheme.colorScheme.onSurface,     focusedColor: Color = MaterialTheme.colorScheme.inverseOnSurface,     pressedColor: Color = focusedColor,     disabledColor: Color = color ): WideButtonContentColor ``` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButtonContentColor` that represents the default content colors used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` | Parameters | |---|---| | `color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = MaterialTheme.colorScheme.onSurface` | the content color of this Button when enabled | | `focusedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = MaterialTheme.colorScheme.inverseOnSurface` | the content color of this Button when enabled and focused | | `pressedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = focusedColor` | the content color of this Button when enabled and pressed | | `disabledColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = color` | the content color of this Button when not enabled | ### glow Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0) ``` fun glow(glow: Glow = Glow.None, focusedGlow: Glow = glow, pressedGlow: Glow = glow): ButtonGlow ``` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonGlow` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow`s used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` | Parameters | |---|---| | `glow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow = Glow.None` | the Glow behind this Button when enabled | | `focusedGlow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow = glow` | the Glow behind this Button when focused | | `pressedGlow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow = glow` | the Glow behind this Button when pressed | ### scale Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0) ``` fun scale(     scale: @FloatRange(from = 0.0) Float = 1.0f,     focusedScale: @FloatRange(from = 0.0) Float = 1.1f,     pressedScale: @FloatRange(from = 0.0) Float = scale,     disabledScale: @FloatRange(from = 0.0) Float = scale,     focusedDisabledScale: @FloatRange(from = 0.0) Float = disabledScale ): ButtonScale ``` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonScale` that represents the default scales used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)`. Scale is used to modify the size of a composable in different `https://developer.android.com/reference/kotlin/androidx/compose/foundation/interaction/Interaction` states e.g. 1f (original) in default state, 1.2f (scaled up) in focused state, 0.8f (scaled down) in pressed state, etc. | Parameters | |---|---| | `scale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = 1.0f` | the scale to be used for this Button when enabled | | `focusedScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = 1.1f` | the scale to be used for this Button when focused | | `pressedScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = scale` | the scale to be used for this Button when pressed | | `disabledScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = scale` | the scale to be used for this Button when disabled | | `focusedDisabledScale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = disabledScale` | the scale to be used for this Button when disabled and focused | ### shape Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0) ``` fun shape(     shape: Shape = ContainerShape,     focusedShape: Shape = shape,     pressedShape: Shape = shape,     disabledShape: Shape = shape,     focusedDisabledShape: Shape = disabledShape ): ButtonShape ``` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ButtonShape` that represents the default container shapes used in a `https://developer.android.com/reference/kotlin/androidx/tv/material3/WideButton.composable#WideButton(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Boolean,androidx.compose.foundation.interaction.MutableInteractionSource,kotlin.Function0,androidx.tv.material3.ButtonScale,androidx.tv.material3.ButtonGlow,androidx.tv.material3.ButtonShape,androidx.tv.material3.WideButtonContentColor,androidx.compose.ui.unit.Dp,androidx.tv.material3.ButtonBorder,androidx.compose.foundation.layout.PaddingValues,kotlin.Function1)` | Parameters | |---|---| | `shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = ContainerShape` | the shape used when the Button is enabled, and has no other `https://developer.android.com/reference/kotlin/androidx/compose/foundation/interaction/Interaction`s | | `focusedShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = shape` | the shape used when the Button is enabled and focused | | `pressedShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = shape` | the shape used when the Button is enabled pressed | | `disabledShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = shape` | the shape used when the Button is not enabled | | `focusedDisabledShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = disabledShape` | the shape used when the Button is not enabled and focused |