.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar-modules-foreign-toplevel" "5" "2022-12-17"
.P
.SH NAME
foreign-toplevel - This module provides information about toplevel windows in Wayland
.P
.SH DESCRIPTION
.P
This module uses the \fIwlr foreign toplevel management\fR Wayland
protocol to provide information about currently open windows, such as
their application ID, window title, and their current state
(maximized/minimized/fullscreen/activated).\&
.P
The configuration for the foreign-toplevel module specifies a
\fItemplate\fR particle.\& This particle will be instantiated once for each
window.\&
.P
Note: Wayland only.\&
.P
.P
.SH TAGS
.P
.TS
allbox;l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
app-id
T}	T{
string
T}	T{
The application ID (typically the application name)
T}
T{
title
T}	T{
string
T}	T{
The window title
T}
T{
maximized
T}	T{
bool
T}	T{
True if the window is currently maximized
T}
T{
minimized
T}	T{
bool
T}	T{
True if the window is currently minimized
T}
T{
fullscreen
T}	T{
bool
T}	T{
True if the window is currently fullscreened
T}
T{
activated
T}	T{
bool
T}	T{
True if the window is currently activated (i.\&e.\& has focus)
T}
.TE
.sp 1
.P
.SH CONFIGURATION
.P
.TS
allbox;l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
content
T}	T{
particle
T}	T{
yes
T}	T{
Template particle that will be instantiated once for each window
T}
T{
all-monitors
T}	T{
bool
T}	T{
no
T}	T{
When set to true, only windows on the same monitor the bar will be used.\& The default is false.\&
T}
.TE
.sp 1
.P
.SH EXAMPLES
.P
.nf
.RS 4
bar:
  left:
    - foreign-toplevel:
        content:
          map:
            conditions:
              ~activated: {empty: {}}
              activated:
                - string: {text: "{app-id}: {title}"}
.fi
.RE
.P
.SH SEE ALSO
.P
\fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)