.\" 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-river" "5" "2022-12-17"
.P
.SH NAME
river - This module provides information about the river tags
.P
.SH DESCRIPTION
.P
This module uses river'\&s (https://github.\&com/ifreund/river, a dynamic
tiling Wayland compositor) status protocol to provide information
about the river tags.\&
.P
It has an interface similar to the i3/sway module.\&
.P
The configuration for the river module specifies one \fItitle\fR particle,
which will be instantiated once for each seat, with tags representing
the seats'\& name, the title of the seats'\& currently focused view, and
its current river "mode".\&
.P
It also specifies a \fIcontent\fR template particle, which is instantiated
once for all 32 river tags.\& This means you probably want to use a
\fBmap\fR particle to hide unused river tags.\&
.P
.SH TAGS (for the "content" particle)
.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{
id
T}	T{
int
T}	T{
River tag number
T}
T{
urgent
T}	T{
bool
T}	T{
True if the river tag has at least one urgent view.\&
T}
T{
visible
T}	T{
bool
T}	T{
True if the river tag is focused by at least one output (i.\&e.\& visible on at least one monitor).\&
T}
T{
focused
T}	T{
bool
T}	T{
True if the river tag is \fIvisible\fR and has keyboard focus.\&
T}
T{
occupied
T}	T{
bool
T}	T{
True if the river tag has views (i.\&e.\& windows).\&
T}
T{
state
T}	T{
string
T}	T{
Set to \fBurgent\fR if \fIurgent\fR is true, \fBfocused\fR if \fIfocused\fR is true, \fBunfocused\fR if \fIvisible\fR is true, but \fIfocused\fR is false, or \fBinvisible\fR if the river tag is not visible on any monitors.\&
T}
.TE
.sp 1
.P
.SH TAGS (for the "title" particle)
.P
.TS
allbox;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{
seat
T}	T{
string
T}	T{
The name of the seat (\fBtitle\fR particle only, see CONFIGURATION)
T}
T{
title
T}	T{
string
T}	T{
The seat'\&s focused view'\&s title (\fBtitle\fR particle only, see CONFIGURATION)
T}
T{
mode
T}	T{
string
T}	T{
The seat'\&s current mode (entered with e.\&g.\& \fBriverctl enter-mode foobar\fR)
T}
.TE
.sp 1
.P
.SH CONFIGURATION
.P
.TS
allbox;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{
title
T}	T{
particle
T}	T{
no
T}	T{
Particle that will be instantiated with the \fIseat\fR and \fItitle\fR tags.\&
T}
T{
content
T}	T{
particle
T}	T{
yes
T}	T{
Template particle that will be instantiated once for all of the 32 river tags.\&
T}
T{
all-monitors
T}	T{
bool
T}	T{
no
T}	T{
When set to false (the default), tags reflect river tags and seats for the monitor yambar is on only.\& When set to true, tags reflect the union of all monitors.\&
T}
.TE
.sp 1
.SH EXAMPLES
.P
.nf
.RS 4
bar:
  left:
    - river:
        title: {string: { text: "{seat} - {title} ({mode})" }}
        content:
          map:
            conditions:
              ~occupied: {empty: {}}
              occupied:
                string:
                  margin: 5
                  text: "{id}: {state}"
.fi
.RE
.P
.SH SEE ALSO
.P
\fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)
.P