1yambar-modules-i3(5) File Formats Manual yambar-modules-i3(5)
2
6 i3 - This module monitors i3 and sway workspaces
7
9 Unlike other modules where the content attribute is just a single par‐
10 ticle, the i3 module's content is an associative array mapping i3/sway
11 workspace names to a particle.
12 You can add an empty workspace name, "", as a catch-all workspace par‐
14 ticle. The i3 module will fallback to this entry if it cannot find the
15 workspace name in the content map.
16 It also recognizes the special name current, which always represents
18 the currently focused workspace. On Sway, this can be used together
19 with the application and title tags to replace the X11-only xwindow
20 module.
21
23 ┌────────────┬────────┬─────────────────────┐
24 │Name │ Type │ Description │
25 ├────────────┼────────┼─────────────────────┤
26 │name │ string │ The workspace name │
27 ├────────────┼────────┼─────────────────────┤
28 │visible │ bool │ True if the │
29 │ │ │ workspace is cur‐ │
30 │ │ │ rently visible (on │
31 │ │ │ any output) │
32 ├────────────┼────────┼─────────────────────┤
33 │focused │ bool │ True if the │
34 │ │ │ workspace is cur‐ │
35 │ │ │ rently focused │
36 ├────────────┼────────┼─────────────────────┤
37 │urgent │ bool │ True if the │
38 │ │ │ workspace has the │
39 │ │ │ urgent flag set │
40 ├────────────┼────────┼─────────────────────┤
41 │empty │ bool │ True if the │
42 │ │ │ workspace is empty │
43 ├────────────┼────────┼─────────────────────┤
44 │state │ string │ One of urgent, fo‐ │
45 │ │ │ cused, unfocused or │
46 │ │ │ invisible (note: │
47 │ │ │ unfocused is when │
48 │ │ │ it is visible, but │
49 │ │ │ neither focused nor │
50 │ │ │ urgent). │
51 ├────────────┼────────┼─────────────────────┤
52 │application │ string │ Name of application │
53 │ │ │ currently focused │
54 │ │ │ on this workspace │
55 │ │ │ (Sway only - use │
56 │ │ │ the xwindow module │
57 │ │ │ in i3) │
58 ├────────────┼────────┼─────────────────────┤
59 │title │ string │ This workspace's │
60 │ │ │ focused window's │
61 │ │ │ title │
62 ├────────────┼────────┼─────────────────────┤
63 │mode │ string │ The name of the │
64 │ │ │ current mode │
65 └────────────┴────────┴─────────────────────┘
66
68 ┌──────────────┬─────────────────┬─────┬──────────────────┐
69 │Name │ Type │ Req │ Description │
70 ├──────────────┼─────────────────┼─────┼──────────────────┤
71 │content │ associative ar‐ │ yes │ Unlike other │
72 │ │ ray │ │ modules, content │
73 │ │ │ │ is an associa‐ │
74 │ │ │ │ tive array map‐ │
75 │ │ │ │ ping workspace │
76 │ │ │ │ names to parti‐ │
77 │ │ │ │ cles. Use "" to │
78 │ │ │ │ specify a de‐ │
79 │ │ │ │ fault fallback │
80 │ │ │ │ particle, or │
81 │ │ │ │ current for the │
82 │ │ │ │ currently active │
83 │ │ │ │ workspace. │
84 ├──────────────┼─────────────────┼─────┼──────────────────┤
85 │sort │ enum │ no │ How to sort the │
86 │ │ │ │ list of │
87 │ │ │ │ workspaces; one │
88 │ │ │ │ of none, ascend‐ │
89 │ │ │ │ ing or descend‐ │
90 │ │ │ │ ing, defaults to │
91 │ │ │ │ none. │
92 ├──────────────┼─────────────────┼─────┼──────────────────┤
93 │persistent │ list of strings │ no │ Persistent │
94 │ │ │ │ workspaces. I.e. │
95 │ │ │ │ workspaces that │
96 │ │ │ │ are never re‐ │
97 │ │ │ │ moved, even if │
98 │ │ │ │ empty. │
99 ├──────────────┼─────────────────┼─────┼──────────────────┤
100 │left-spacing │ int │ no │ Space, in pix‐ │
101 │ │ │ │ els, on the │
102 │ │ │ │ left-side of │
103 │ │ │ │ each rendered │
104 │ │ │ │ workspace parti‐ │
105 │ │ │ │ cle │
106 ├──────────────┼─────────────────┼─────┼──────────────────┤
107 │right-spacing │ int │ no │ Space, in pix‐ │
108 │ │ │ │ els, on the │
109 │ │ │ │ right-side of │
110 │ │ │ │ each rendered │
111 │ │ │ │ workspace parti‐ │
112 │ │ │ │ cle │
113 ├──────────────┼─────────────────┼─────┼──────────────────┤
114 │spacing │ int │ no │ Short-hand for │
115 │ │ │ │ setting both │
116 │ │ │ │ left-spacing and │
117 │ │ │ │ right-spacing │
118 └──────────────┴─────────────────┴─────┴──────────────────┘
119
121 This renders all workspace names, with an * indicating the currently
122 focused one. It also renders the currently focused application name and
123 window title.
124 bar:
126 left:
127 - i3:
128 content:
129 "":
130 map:
131 tag: state
132 default: {string: {text: "{name}"}}
133 values:
134 focused: {string: {text: "{name}*"}}
135 current: { string: {text: "{application}: {title}"}}
136
138 yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
139 tions(5)
140 2022-08-26 yambar-modules-i3(5)