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  │
26       │      │       │     │ color. See yam‐ │
27       │      │       │     │ bar(5) for for‐ │
28       │      │       │     │ mat.            │
29       └──────┴───────┴─────┴─────────────────┘
30
31   EXAMPLES
32           content:
33             string:
34               deco:
35                 background:
36                   color: 00ff00ff
37

UNDERLINE

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

BORDER

66       This decoration renders a border of configurable size (i.e border
67       width) around the particle.
68
69   CONFIGURATION
70       ┌──────┬───────┬─────┬──────────────────┐
71       │Name  │ Type  │ Req │ Description      │
72       ├──────┼───────┼─────┼──────────────────┤
73       │color │ color │ yes │ The color of the │
74       │      │       │     │ line. See yam‐   │
75       │      │       │     │ bar(5) for for‐  │
76       │      │       │     │ mat.             │
77       ├──────┼───────┼─────┼──────────────────┤
78       │size  │ int   │ no  │ Border width, in │
79       │      │       │     │ pixels. Defaults │
80       │      │       │     │ to 1px.          │
81       └──────┴───────┴─────┴──────────────────┘
82
83   EXAMPLES
84           content:
85             string:
86               deco:
87                 border:
88                   size: 2
89                   color: ff0000ff
90

STACK

92       This particles combines multiple decorations.
93
94   CONFIGURATION
95       No configuration attributes available. The stack is just a list of the
96       decorations that should be combined.
97
98   EXAMPLES
99           content:
100             string:
101               deco:
102                 stack:
103                   - background: ...
104                   - underline: ...
105

SEE ALSO

107       yambar-particles(5)
108
109
110
111                                  2022-08-26             yambar-decorations(5)