1yambar-decorations(5)         File Formats Manual        yambar-decorations(5)
2
3
4

NAME

6       yambar-decorations - configuration file
7

DESCRIPTION

9       Decorations are optional additions to particles, enabling you to e.g.
10       change the background color of the entire particle, draw an underline
11       and so on.
12
13       Decorations are applied to the particle's margins as well.
14
15       All decorations define their own configuration attributes, and there
16       are no common attributes.
17

BACKGROUND

19       This decoration sets the particles background color.
20
21   CONFIGURATION
22       ┌──────┬───────┬─────┬─────────────────────────────────────────────────┐
23       │Name  │ Type  │ Req │ Description                                     │
24       ├──────┼───────┼─────┼─────────────────────────────────────────────────┤
25       │color │ color │ yes │ The background color. See yambar(5) for format. │
26       └──────┴───────┴─────┴─────────────────────────────────────────────────┘
27
28   EXAMPLES
29           content:
30             string:
31               deco:
32                 background:
33                   color: 00ff00ff
34

UNDERLINE

36       This decoration renders a line of configurable size and color at the
37       bottom of the particle.
38
39   CONFIGURATION
40       ┌──────┬───────┬─────┬─────────────────────────────────────────────────┐
41       │Name  │ Type  │ Req │ Description                                     │
42       ├──────┼───────┼─────┼─────────────────────────────────────────────────┤
43       │size  │ int   │ yes │ The size (height/thickness) of the line, in     │
44       │      │       │     │ pixels                                          │
45       ├──────┼───────┼─────┼─────────────────────────────────────────────────┤
46       │color │ color │ yes │ The color of the line. See yambar(5) for for‐   │
47       │      │       │     │ mat.                                            │
48       └──────┴───────┴─────┴─────────────────────────────────────────────────┘
49
50   EXAMPLES
51           content:
52             string:
53               deco:
54                 underline:
55                   size: 2
56                   color: ff0000ff
57

OVERLINE

59       Similar to underline, this decoration renders a line of configurable
60       size and color at the top of the particle.
61
62   CONFIGURATION
63       ┌──────┬───────┬─────┬─────────────────────────────────────────────────┐
64       │Name  │ Type  │ Req │ Description                                     │
65       ├──────┼───────┼─────┼─────────────────────────────────────────────────┤
66       │size  │ int   │ yes │ The size (height/thickness) of the line, in     │
67       │      │       │     │ pixels                                          │
68       ├──────┼───────┼─────┼─────────────────────────────────────────────────┤
69       │color │ color │ yes │ The color of the line. See yambar(5) for for‐   │
70       │      │       │     │ mat.                                            │
71       └──────┴───────┴─────┴─────────────────────────────────────────────────┘
72
73   EXAMPLES
74           content:
75             string:
76               deco:
77                 overline:
78                   size: 2
79                   color: ff0000ff
80

BORDER

82       This decoration renders a border of configurable size (i.e border
83       width) around the particle.
84
85   CONFIGURATION
86       ┌──────┬───────┬─────┬─────────────────────────────────────────────────┐
87       │Name  │ Type  │ Req │ Description                                     │
88       ├──────┼───────┼─────┼─────────────────────────────────────────────────┤
89       │color │ color │ yes │ The color of the line. See yambar(5) for for‐   │
90       │      │       │     │ mat.                                            │
91       ├──────┼───────┼─────┼─────────────────────────────────────────────────┤
92       │size  │ int   │ no  │ Border width, in pixels. Defaults to 1px.       │
93       └──────┴───────┴─────┴─────────────────────────────────────────────────┘
94
95   EXAMPLES
96           content:
97             string:
98               deco:
99                 border:
100                   size: 2
101                   color: ff0000ff
102

STACK

104       This particles combines multiple decorations.
105
106   CONFIGURATION
107       No configuration attributes available. The stack is just a list of the
108       decorations that should be combined.
109
110   EXAMPLES
111           content:
112             string:
113               deco:
114                 stack:
115                   - background: ...
116                   - underline: ...
117

SEE ALSO

119       yambar-particles(5)
120
121
122
123                                  2023-07-22             yambar-decorations(5)