File size: 2,627 Bytes
5b76e0f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | # Border
The `border` rule enables the drawing of a box around a widget. A border is set with a border value (see below) followed by a color.
Borders may also be set individually for the four edges of a widget with the `border-top`, `border-right`, `border-bottom` and `border-left` rules.
## Syntax
```
border: [<COLOR>] [<BORDER VALUE>];
border-top: [<COLOR>] [<BORDER VALUE>];
border-right: [<COLOR>] [<BORDER VALUE>];
border-bottom: [<COLOR>] [<BORDER VALUE>];
border-left: [<COLOR>] [<BORDER VALUE>];
```
### Values
| Border value | Description |
|--------------|---------------------------------------------------------|
| `"ascii"` | A border with plus, hyphen, and vertical bar |
| `"blank"` | A blank border (reserves space for a border) |
| `"dashed"` | Dashed line border |
| `"double"` | Double lined border |
| `"heavy"` | Heavy border |
| `"hidden"` | Alias for "none" |
| `"hkey"` | Horizontal key-line border |
| `"inner"` | Thick solid border |
| `"none"` | Disabled border |
| `"outer"` | Think solid border with additional space around content |
| `"round"` | Rounded corners |
| `"solid"` | Solid border |
| `"tall"` | Solid border with extras space top and bottom |
| `"vkey"` | Vertical key-line border |
| `"wide"` | Solid border with additional space left and right |
For example, `heavy white` would display a heavy white line around a widget.
## Border command
The `textual` CLI has a subcommand which will let you explore the various border types:
```
textual borders
```
## Example
This examples shows three widgets with different border styles.
=== "border.py"
```python
--8<-- "docs/examples/styles/border.py"
```
=== "border.css"
```css
--8<-- "docs/examples/styles/border.css"
```
=== "Output"
```{.textual path="docs/examples/styles/border.py"}
```
## CSS
```sass
/* Set a heavy white border */
border: heavy white;
/* set a red border on the left */
border-left: outer red;
```
## Python
```python
# Set a heavy white border
widget.border = ("heavy", "white")
# Set a red border on the left
widget.border_left = ("outer", "red")
```
|