Theme Settings

Warning

The actual colors displayed in your terminal can change depending on your terminal settings

About Colors

All color settings can be the actual color written out as a word, available values are:

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white

And their light variants (light red, light white, ...). Also if you want to use the terminal default, you can set the color to default

Hex values are also supported.

Global palette

0.3.0

wiki-tui supports changing the color palette. If you change them globally, every interface of wiki-tui will change.

Background

0.3.0 · Default: white

This color is used for the view backgrounds

theme.background = "white"

Title

0.3.0 · Default: red

This color is used for the title

theme.title = "red"

Highlight

0.3.0 · Default: red

This color is used for the highlighted text background

theme.highlight = "red"

Highlight Inactive

0.3.0 · Default: blue

This color is used for the inactive text that is highlighted

theme.highlight_inactive = "blue"

Highlight Text

0.3.0 · Default: white

This color is used for the highlighted text

theme.highlight_text = "white"

Text

0.3.0 · Default: black

This color is used for the text color

theme.text = "black"

Search Match

0.3.0 · Default: red

This color is used for a search match

theme.search_match = "red"

Customize single views

0.4.0

You can also only change colors for a single view (for example the search bar). Every supported view has the same settings as the global theme settings. Supported Views are:

• search_bar
• search_results
• search_preview
• article_view
• toc_view

Here is a sample config for changing the colors of the search bar:

[theme.search_bar]
background = "white"
title = "red"
highlight = "red"
highlight_inactive = "blue"
highlight_text = "white"
text = "black"

Configure the borders

0.6.0 Default: default | thin

Warning

Depending on your font, some border styles may differ from the examples below

You can change the look of the borders in wiki-tui. Available styles are:

• thin | default
• heavy
• round

The excat unicode characters used for the borders can be found in the following file: src/ui/panel.rs

Thin / Default

theme.border = "default"

or

theme.border = "thin"

Heavy

theme.border = "heavy"

Round

theme.border = "round"

---

Last update: November 14, 2022
Created: August 4, 2022