# Border

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


```
class Border
```

<br />

*** ** * ** ***

Defines the border for a TV component.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#None()` Signifies the absence of a border. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#Border(androidx.compose.foundation.BorderStroke,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape)(border: https://developer.android.com/reference/kotlin/androidx/compose/foundation/BorderStroke, inset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp, shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape)` |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#copy(androidx.compose.foundation.BorderStroke,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape)(border: https://developer.android.com/reference/kotlin/androidx/compose/foundation/BorderStroke?, inset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp?, shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape?)` |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/BorderStroke` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#border()` configures the width and brush for the border |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#inset()` defines how far (in dp) should the border be from the component it's applied to |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/Border#shape()` defines the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` of the border |

## Public companion properties

### None

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

```
val None: Border
```

Signifies the absence of a border. Use this if you do not want to display a border indication in any of the TV Components.

## Public constructors

### Border

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

```
Border(
    border: BorderStroke,
    inset: Dp = 0.dp,
    shape: Shape = ShapeTokens.BorderDefaultShape
)
```

| Parameters |
|---|---|
| `border: https://developer.android.com/reference/kotlin/androidx/compose/foundation/BorderStroke` | configures the width and brush for the border |
| `inset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = 0.dp` | defines how far (in dp) should the border be from the component it's applied to |
| `shape: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape = ShapeTokens.BorderDefaultShape` | defines the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` of the border |

## Public functions

### copy

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

```
fun copy(border: BorderStroke? = null, inset: Dp? = null, shape: Shape? = null): Border
```

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### border

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

```
val border: BorderStroke
```

configures the width and brush for the border

### inset

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

```
val inset: Dp
```

defines how far (in dp) should the border be from the component it's applied to

### shape

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

```
val shape: Shape
```

defines the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` of the border