yambar-modules-foreign-toplevel - Man Page

This module provides information about toplevel windows in Wayland

Description

This module uses the wlr foreign toplevel management Wayland protocol to provide information about currently open windows, such as their application ID, window title, and their current state (maximized/minimized/fullscreen/activated).

The configuration for the foreign-toplevel module specifies a template particle. This particle will be instantiated once for each window.

Note: Wayland only.

Tags

NameTypeDescription
app-idstringThe application ID (typically the application name)
titlestringThe window title
maximizedboolTrue if the window is currently maximized
minimizedboolTrue if the window is currently minimized
fullscreenboolTrue if the window is currently fullscreened
activatedboolTrue if the window is currently activated (i.e. has focus)

Configuration

NameTypeReqDescription
contentparticleyesTemplate particle that will be instantiated once for each window
all-monitorsboolnoWhen set to true, only windows on the same monitor the bar will be used. The default is false.

Examples

  bar:
    left:
      - foreign-toplevel:
          content:
            map:
              tag: activated
              values:
                false: {empty: {}}
                true:
                  - string: {text: "{app-id}: {title}"}

See Also

yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decorations(5)

Info

2022-08-26