1yambar-modules-river(5) File Formats Manual yambar-modules-river(5)
2
6 river - This module provides information about the river tags
7
9 This module uses river's (https://github.com/ifreund/river, a dynamic
10 tiling Wayland compositor) status protocol to provide information about
11 the river tags.
12 It has an interface similar to the i3/sway module.
14 The configuration for the river module specifies one title particle,
16 which will be instantiated once for each seat, with tags representing
17 the seats' name, the title of the seats' currently focused view, and
18 its current river "mode".
19 It also specifies a content template particle, which is instantiated
21 once for all 32 river tags. This means you probably want to use a map
22 particle to hide unused river tags.
23
25 ┌─────────┬────────┬───────────────────────────────────────────────────┐
26 │Name │ Type │ Description │
27 ├─────────┼────────┼───────────────────────────────────────────────────┤
28 │id │ int │ River tag number │
29 ├─────────┼────────┼───────────────────────────────────────────────────┤
30 │urgent │ bool │ True if the river tag has at least one urgent │
31 │ │ │ view. │
32 ├─────────┼────────┼───────────────────────────────────────────────────┤
33 │visible │ bool │ True if the river tag is focused by at least one │
34 │ │ │ output (i.e. visible on at least one monitor). │
35 ├─────────┼────────┼───────────────────────────────────────────────────┤
36 │focused │ bool │ True if the river tag is visible and has keyboard │
37 │ │ │ focus. │
38 ├─────────┼────────┼───────────────────────────────────────────────────┤
39 │occupied │ bool │ True if the river tag has views (i.e. windows). │
40 ├─────────┼────────┼───────────────────────────────────────────────────┤
41 │state │ string │ Set to urgent if urgent is true, focused if fo‐ │
42 │ │ │ cused is true, unfocused if visible is true, but │
43 │ │ │ focused is false, or invisible if the river tag │
44 │ │ │ is not visible on any monitors. │
45 └─────────┴────────┴───────────────────────────────────────────────────┘
46
48 ┌───────┬────────┬─────────────────────────────────────────────────────┐
49 │Name │ Type │ Description │
50 ├───────┼────────┼─────────────────────────────────────────────────────┤
51 │seat │ string │ The name of the seat. │
52 ├───────┼────────┼─────────────────────────────────────────────────────┤
53 │title │ string │ The seat's focused view's title. │
54 ├───────┼────────┼─────────────────────────────────────────────────────┤
55 │mode │ string │ The seat's current mode (entered with e.g. riverctl │
56 │ │ │ enter-mode foobar). │
57 ├───────┼────────┼─────────────────────────────────────────────────────┤
58 │layout │ string │ Current layout of the output currently focused by │
59 │ │ │ the seat. │
60 └───────┴────────┴─────────────────────────────────────────────────────┘
61
63 ┌─────────────┬──────────┬─────┬───────────────────────────────────────┐
64 │Name │ Type │ Req │ Description │
65 ├─────────────┼──────────┼─────┼───────────────────────────────────────┤
66 │title │ particle │ no │ Particle that will be instantiated │
67 │ │ │ │ with the seat and title tags. │
68 ├─────────────┼──────────┼─────┼───────────────────────────────────────┤
69 │content │ particle │ yes │ Template particle that will be in‐ │
70 │ │ │ │ stantiated once for all of the 32 │
71 │ │ │ │ river tags. │
72 ├─────────────┼──────────┼─────┼───────────────────────────────────────┤
73 │all-monitors │ bool │ no │ When set to false (the default), tags │
74 │ │ │ │ reflect river tags and seats for the │
75 │ │ │ │ monitor yambar is on only. When set │
76 │ │ │ │ to true, tags reflect the union of │
77 │ │ │ │ all monitors. │
78 └─────────────┴──────────┴─────┴───────────────────────────────────────┘
79
81 bar:
82 left:
83 - river:
84 title: {string: { text: "{seat} - {title} ({layout}/{mode})" }}
85 content:
86 map:
87 conditions:
88 ~occupied: {empty: {}}
89 occupied:
90 string:
91 margin: 5
92 text: "{id}: {state}"
93
95 yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
96 tions(5)
97 2023-07-22 yambar-modules-river(5)