1yambar-modules-foreign-toplevelF(i5l)e Formats Maynaumablar-modules-foreign-toplevel(5)
2
3
4

NAME

6       foreign-toplevel - This module provides information about toplevel win‐
7       dows in Wayland
8

DESCRIPTION

10       This module uses the wlr foreign toplevel management Wayland protocol
11       to provide information about currently open windows, such as their ap‐
12       plication ID, window title, and their current state (maximized/mini‐
13       mized/fullscreen/activated).
14
15       The configuration for the foreign-toplevel module specifies a template
16       particle. This particle will be instantiated once for each window.
17
18       Note: Wayland only.
19

TAGS

21       ┌───────────┬────────┬─────────────────────┐
22Name       Type   Description         
23       ├───────────┼────────┼─────────────────────┤
24       │app-id     │ string │ The application ID  │
25       │           │        │ (typically the ap‐  │
26       │           │        │ plication name)     │
27       ├───────────┼────────┼─────────────────────┤
28       │title      │ string │ The window title    │
29       ├───────────┼────────┼─────────────────────┤
30       │maximized  │ bool   │ True if the window  │
31       │           │        │ is currently maxi‐  │
32       │           │        │ mized               │
33       ├───────────┼────────┼─────────────────────┤
34       │minimized  │ bool   │ True if the window  │
35       │           │        │ is currently mini‐  │
36       │           │        │ mized               │
37       ├───────────┼────────┼─────────────────────┤
38       │fullscreen │ bool   │ True if the window  │
39       │           │        │ is currently        │
40       │           │        │ fullscreened        │
41       ├───────────┼────────┼─────────────────────┤
42       │activated  │ bool   │ True if the window  │
43       │           │        │ is currently acti‐  │
44       │           │        │ vated (i.e. has fo‐ │
45       │           │        │ cus)                │
46       └───────────┴────────┴─────────────────────┘
47

CONFIGURATION

49       ┌─────────────┬──────────┬─────┬──────────────────┐
50Name         Type     Req Description      
51       ├─────────────┼──────────┼─────┼──────────────────┤
52       │content      │ particle │ yes │ Template parti‐  │
53       │             │          │     │ cle that will be │
54       │             │          │     │ instantiated     │
55       │             │          │     │ once for each    │
56       │             │          │     │ window           │
57       ├─────────────┼──────────┼─────┼──────────────────┤
58       │all-monitors │ bool     │ no  │ When set to      │
59       │             │          │     │ true, only win‐  │
60       │             │          │     │ dows on the same │
61       │             │          │     │ monitor the bar  │
62       │             │          │     │ will be used.    │
63       │             │          │     │ The default is   │
64       │             │          │     │ false.           │
65       └─────────────┴──────────┴─────┴──────────────────┘
66

EXAMPLES

68           bar:
69             left:
70               - foreign-toplevel:
71                   content:
72                     map:
73                       tag: activated
74                       values:
75                         false: {empty: {}}
76                         true:
77                           - string: {text: "{app-id}: {title}"}
78

SEE ALSO

80       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
81       tions(5)
82
83
84
85                                  2022-08-26yambar-modules-foreign-toplevel(5)
Impressum