NAME

       waybar - river mode module

DESCRIPTION

       The mode module displays the current mapping mode of river.

CONFIGURATION

       Addressed by river/mode

       format:
            typeof: string
            default: {}
            The format, how information should be displayed. On {} data gets inserted.

       rotate:
            typeof: integer
            Positive value to rotate the text label (in 90 degree increments).

       max-length:
            typeof: integer
            The maximum length in character the module should display.

       min-length:
            typeof: integer
            The minimum length in characters the module should accept.

       align:
            typeof: float
            The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. If the
       module is rotated, it will follow the flow of the text.

       justify:
            typeof: string
            The  alignment  of the text within the module's label, allowing options 'left', 'right', or 'center'
       to define the positioning.

       on-click:
            typeof: string
            Command to execute when clicked on the module.

       on-click-middle:
            typeof: string
            Command to execute when middle-clicked on the module using mousewheel.

       on-click-right:
            typeof: string
            Command to execute when you right-click on the module.

       on-update:
            typeof: string
            Command to execute when the module is updated.

       on-scroll-up:
            typeof: string
            Command to execute when scrolling up on the module.

       on-scroll-down:
            typeof: string
            Command to execute when scrolling down on the module.

       smooth-scrolling-threshold:
            typeof: double
            Threshold to be used when scrolling.

       menu:
            typeof: string
            Action that popups the menu.

       menu-file:
            typeof: string
            Location of the menu descriptor file. There need to be an element of type
           GtkMenu with id menu

       menu-actions:
            typeof: array
            The actions corresponding to the buttons of the menu.

       expand:
            typeof: bool
            default: false
            Enables this module to consume all left over space dynamically.

EXAMPLES

           "river/mode": {
                "format": " {}"
           }

STYLE

       •   #mode
       •   #mode.<mode>

                                                   2025-02-21                               waybar-river-mode(5)