.\" Generated by scdoc 1.11.5
.\" 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\-i3" "5" "2026\-10\-30"
.PP
.SH NAME
i3 \- This module monitors i3 and sway workspaces
.PP
.SH DESCRIPTION
.PP
Unlike other modules where the \fIcontent\fR attribute is just a single
\fBparticle\fR, the i3 module'\&s \fIcontent\fR is an associative array mapping
i3/sway workspace names to a particle.\&
.PP
You can add an empty workspace name, \fB""\fR, as a catch\-all workspace
particle.\& The \fBi3\fR module will fallback to this entry if it cannot
find the workspace name in the \fIcontent\fR map.\&
.PP
It also recognizes the special name \fBcurrent\fR, which always represents
the currently focused workspace.\& On Sway, this can be used together
with the \fIapplication\fR and \fItitle\fR tags to replace the X11\-only
\fBxwindow\fR module.\&
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx
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{
name
T}	T{
string
T}	T{
The workspace name
T}
T{
visible
T}	T{
bool
T}	T{
True if the workspace is currently visible (on any output)
T}
T{
focused
T}	T{
bool
T}	T{
True if the workspace is currently focused
T}
T{
urgent
T}	T{
bool
T}	T{
True if the workspace has the urgent flag set
T}
T{
empty
T}	T{
bool
T}	T{
True if the workspace is empty (Sway only)
T}
T{
state
T}	T{
string
T}	T{
One of \fBurgent\fR, \fBfocused\fR, \fBunfocused\fR or \fBinvisible\fR (note: \fBunfocused\fR is when it is visible, but neither focused nor urgent).\&
T}
T{
application
T}	T{
string
T}	T{
Name of application currently focused on this workspace (Sway only \- use the \fBxwindow\fR module in i3)
T}
T{
title
T}	T{
string
T}	T{
This workspace'\&s focused window'\&s title
T}
T{
mode
T}	T{
string
T}	T{
The name of the current mode
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx
l l l lx
l l l lx
l l l lx
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{
associative array
T}	T{
yes
T}	T{
Unlike other modules, \fIcontent\fR is an associative array mapping workspace names to particles.\& Use \fB""\fR to specify a default fallback particle, or \fBcurrent\fR for the currently active workspace.\&
T}
T{
sort
T}	T{
enum
T}	T{
no
T}	T{
How to sort the list of workspaces; one of \fInone\fR, \fInative\fR, \fIascending\fR or \fIdescending\fR, defaults to \fInone\fR.\& Use \fInative\fR to sort numbered workspaces only.\&
T}
T{
strip\-workspace\-numbers
T}	T{
bool
T}	T{
no
T}	T{
If true, \fBN:\fR prefixes will be stripped from workspace names.\& Useful together with \fBsort\fR, to have the workspace order fixed.\&
T}
T{
persistent
T}	T{
list of strings
T}	T{
no
T}	T{
Persistent workspaces.\& I.\&e.\& workspaces that are never removed, even if empty.\&
T}
T{
left\-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, on the left\-side of each rendered workspace particle
T}
T{
right\-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, on the right\-side of each rendered workspace particle
T}
T{
spacing
T}	T{
int
T}	T{
no
T}	T{
Short\-hand for setting both \fIleft\-spacing\fR and \fIright\-spacing\fR
T}
.TE
.sp 1
.SH EXAMPLES
.PP
This renders all workspace names, with an \fB*\fR indicating the
currently focused one.\& It also renders the currently focused
application name and window title.\&
.PP
.nf
.RS 4
bar:
  left:
    \- i3:
        content:
          "":
            map:
              default: {string: {text: "{name}"}}
              conditions:
                state == focused: {string: {text: "{name}*"}}
          current: { string: {text: "{application}: {title}"}}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar\-modules\fR(5), \fByambar\-particles\fR(5), \fByambar\-tags\fR(5), \fByambar\-decorations\fR(5)
.PP