# ClickableSurfaceDefaults

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/SurfaceDefaults.kt+class:androidx.tv.material3.ClickableSurfaceDefaults) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)


```
object ClickableSurfaceDefaults
```

<br />

*** ** * ** ***

Contains the default values used by clickable Surface.

## Summary

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceBorder` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceDefaults#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/ClickableSurfaceBorder` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border`s applied on a Surface in different `https://developer.android.com/reference/kotlin/androidx/compose/foundation/interaction/Interaction` states. |
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceDefaults#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,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, focusedContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, focusedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, pressedContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, pressedContentColor: 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 )` Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceColors` that represents the default container \& content colors used in a Surface. |
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceGlow` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceDefaults#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/ClickableSurfaceGlow` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow`s used in a Surface. |
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceScale` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceDefaults#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/ClickableSurfaceScale` that represents the default scales used in a Surface. scales are 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. |
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceShape` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceDefaults#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/ClickableSurfaceShape` that represents the default container shapes used in a Surface. |

## Public functions

### 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 = ShapeDefaults.Small,
            )
): ClickableSurfaceBorder
```

Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceBorder` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border`s applied on a Surface 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 Surface 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 Surface 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 Surface 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 Surface 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 = ShapeDefaults.Small, )` | the `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` to be used for this Surface when disabled and focused |

### colors

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/tv#1.1.0)

```
@Composable
fun colors(
    containerColor: Color = MaterialTheme.colorScheme.surface,
    contentColor: Color = contentColorFor(containerColor),
    focusedContainerColor: Color = MaterialTheme.colorScheme.inverseSurface,
    focusedContentColor: Color = contentColorFor(focusedContainerColor),
    pressedContainerColor: Color = focusedContainerColor,
    pressedContentColor: Color = contentColorFor(pressedContainerColor),
    disabledContainerColor: Color = MaterialTheme.colorScheme.surfaceVariant.copy(alpha = DisabledContainerAlpha),
    disabledContentColor: Color = MaterialTheme.colorScheme.onSurface
): ClickableSurfaceColors
```

Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceColors` that represents the default container \& content colors used in a Surface.

| Parameters |
|---|---|
| `containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = MaterialTheme.colorScheme.surface` | the container color of this Surface when enabled |
| `contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(containerColor)` | the content color of this Surface when enabled |
| `focusedContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = MaterialTheme.colorScheme.inverseSurface` | the container color of this Surface when enabled and focused |
| `focusedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(focusedContainerColor)` | the content color of this Surface when enabled and focused |
| `pressedContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = focusedContainerColor` | the container color of this Surface when enabled and pressed |
| `pressedContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(pressedContainerColor)` | the content color of this Surface when enabled and pressed |
| `disabledContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = MaterialTheme.colorScheme.surfaceVariant.copy(alpha = DisabledContainerAlpha)` | the container color of this Surface when not enabled |
| `disabledContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = MaterialTheme.colorScheme.onSurface` | the content color of this Surface 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): ClickableSurfaceGlow
```

Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceGlow` that represents the default `https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow`s used in a Surface.

| Parameters |
|---|---|
| `glow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow = Glow.None` | the Glow behind this Surface when enabled |
| `focusedGlow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow = glow` | the Glow behind this Surface when focused |
| `pressedGlow: https://developer.android.com/reference/kotlin/androidx/tv/material3/Glow = glow` | the Glow behind this Surface 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
): ClickableSurfaceScale
```

Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceScale` that represents the default scales used in a Surface. scales are 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 Surface 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 Surface 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 Surface 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 Surface 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 Surface when disabled and focused |

### shape

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
@Composable
fun shape(
    shape: Shape = MaterialTheme.shapes.medium,
    focusedShape: Shape = shape,
    pressedShape: Shape = shape,
    disabledShape: Shape = shape,
    focusedDisabledShape: Shape = disabledShape
): ClickableSurfaceShape
```

Creates a `https://developer.android.com/reference/kotlin/androidx/tv/material3/ClickableSurfaceShape` that represents the default container shapes used in a Surface.

| Parameters |
|---|---|
| `shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = MaterialTheme.shapes.medium` | the shape used when the Surface 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 Surface is enabled and focused. |
| `pressedShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = shape` | the shape used when the Surface is enabled pressed. |
| `disabledShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = shape` | the shape used when the Surface is not enabled. |
| `focusedDisabledShape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = disabledShape` | the shape used when the Surface is not enabled and focused. |