1# Style
2
3A style object contains the following information:
4
5- [fg][1]
6- [bg][2]
7- [add_modifiers][3]
8- [sub_modifiers][4]
9
10### fg
11
12Type: nullable [Color][5]
13
14The foreground color.
15
16### bg
17
18Type: nullable [Color][5]
19
20The background color.
21
22### add_modifiers
23
24Type: nullable list of [Modifier][6]
25
26Modifiers to add.
27
28### sub_modifiers
29
30Type: nullable list of [Modifier][6]
31
32Modifiers to remove.
33
34## Color
35
36Color can be one of the following:
37
38- "Reset"
39- "Black"
40- "Red"
41- "Green"
42- "Yellow"
43- "Blue"
44- "Magenta"
45- "Cyan"
46- "Gray"
47- "DarkGray"
48- "LightRed"
49- "LightGreen"
50- "LightYellow"
51- "LightBlue"
52- "LightMagenta"
53- "LightCyan"
54- "White"
55- { Rgb = { int, int, int } }
56- { Indexed = int }
57
58## Modifier
59
60Modifier can be one of the following:
61
62- "Bold"
63- "Dim"
64- "Italic"
65- "Underlined"
66- "SlowBlink"
67- "RapidBlink"
68- "Reversed"
69- "Hidden"
70- "CrossedOut"
71
72## Example
73
74```lua
75xplr.config.general.prompt.style.fg = "Red"
76xplr.config.general.prompt.style.bg = { Rgb = { 100, 150, 200 } }
77xplr.config.general.prompt.style.add_modifiers = { "Bold", "Italic" }
78xplr.config.general.prompt.style.sub_modifiers = { "Hidden" }
79```
80
81[1]: #fg
82[2]: #bg
83[3]: #add_modifiers
84[4]: #sub_modifiers
85[5]: #color
86[6]: #modifier
87