Skip to content

Commit a2650b4

Browse files
authored
Update branding.md for TUI borders (#485)
1 parent 46b5684 commit a2650b4

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

content/en/docs/Reference/branding.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,27 @@ CHECK_MARK="*"
5454
If you set values to 0-9, those simple colors will be used even on 256-color terminals. For the best experience on modern terminals, use hex triplet format.
5555
{{% /alert %}}
5656

57+
58+
### Border customization
59+
60+
The border feature allows you to add customizable borders to UI components. This enhances visual separation and improves the overall design consistency.
61+
62+
By default the border is set as `normal` which just draws a simple square box around the installer. In dumb terminals (16 color) the `ascii` border is selected for maximum compatibility with all terminals. The following options are supported:
63+
64+
- `rounded`: A rounded in the corners box, it should be supported by your terminal font.
65+
- `double`: Border comprised of two thin strokes
66+
- `thick`: Border that's thicker than the normal one
67+
- `normal`: The default square border
68+
- `ascii`: A border done with only ASCII symbols. The default in 16 color terminals
69+
- `off`: No border
70+
71+
As with the colors, the border style can be overriden in the `/etc/kairos/branding/interactive_install_colors` file with the key `BORDER_STYLE`
72+
73+
```bash
74+
# /etc/kairos/branding/interactive_install_colors
75+
BORDER_STYLE="off"
76+
```
77+
5778
### Disabling Advanced Options
5879

5980
If you want to hide the "Customize Further" option in the interactive installer, you can create an empty file at `/etc/kairos/branding/interactive_install_advanced_disabled`. When this file exists, the installer will only show the "Start Install" option, simplifying the interface for users who don't need advanced customization.

0 commit comments

Comments
 (0)