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 (typically the application   │
25       │           │        │ name)                                           │
26       ├───────────┼────────┼─────────────────────────────────────────────────┤
27       │title      │ string │ The window title                                │
28       ├───────────┼────────┼─────────────────────────────────────────────────┤
29       │maximized  │ bool   │ True if the window is currently maximized       │
30       ├───────────┼────────┼─────────────────────────────────────────────────┤
31       │minimized  │ bool   │ True if the window is currently minimized       │
32       ├───────────┼────────┼─────────────────────────────────────────────────┤
33       │fullscreen │ bool   │ True if the window is currently fullscreened    │
34       ├───────────┼────────┼─────────────────────────────────────────────────┤
35       │activated  │ bool   │ True if the window is currently activated (i.e. │
36       │           │        │ has focus)                                      │
37       └───────────┴────────┴─────────────────────────────────────────────────┘
38

CONFIGURATION

40       ┌─────────────┬──────────┬─────┬───────────────────────────────────────┐
41Name         Type     Req Description                           
42       ├─────────────┼──────────┼─────┼───────────────────────────────────────┤
43       │content      │ particle │ yes │ Template particle that will be in‐    │
44       │             │          │     │ stantiated once for each window       │
45       ├─────────────┼──────────┼─────┼───────────────────────────────────────┤
46       │all-monitors │ bool     │ no  │ When set to true, only windows on the │
47       │             │          │     │ same monitor the bar will be used.    │
48       │             │          │     │ The default is false.                 │
49       └─────────────┴──────────┴─────┴───────────────────────────────────────┘
50

EXAMPLES

52           bar:
53             left:
54               - foreign-toplevel:
55                   content:
56                     map:
57                       conditions:
58                         ~activated: {empty: {}}
59                         activated:
60                           - string: {text: "{app-id}: {title}"}
61

SEE ALSO

63       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
64       tions(5)
65
66
67
68                                  2023-07-14yambar-modules-foreign-toplevel(5)
Impressum