Files
textual/docs/styles/border.md
Will McGugan 971ef9e4b1 more border
2022-08-04 15:39:06 +01:00

2.3 KiB

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.

Border value Explanation
"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" A solid border with extras space top and bottom
"vkey" Vertical key-line border
"wide" A solid border with additional space left and right

For examples heavy white would display a heavy white line around a widget.

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.

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"
```

=== "Output"

```{.textual path="docs/examples/styles/border.py"}
```

CSS

/* Set a heavy white border */
border: heavy white;

/* set a red border on the left */
border-left: outer red;

Python

# Set a heavy white border
widget.border = ("heavy", "white)

# Set a red border on the left
widget.border_left = ("outer", "red)