Skip to main content
Version: Next

🧩 Modules

Ashell modules identify the various features of the status bar.

Each module provides a set of functionalities that can be enabled or disabled in the configuration file.

Organize modules

The status bar is divided into three main sections: left, center, and right.

Each section holds a list of modules or module groups, allowing flexible layout configuration.

Modules can be used on their own or organized into groups.

Default configuration

[modules]
left = [ "Workspaces" ]
center = [ "WindowTitle" ]
right = [ [ "Clock", "Privacy", "Settings" ] ]

Example

If we want to add the SystemInfo module to the right side of the status bar but not in the same group as the Clock, Privacy, and Settings modules, we can do it like this:

right = [ "SystemInfo", [ "Clock", "Privacy", "Settings" ] ]

Available modules

The following modules are available:

Updates

Provides information about available updates for the system.

info

This module requires additional configuration to work properly. See the dedicated section in the documentation.

Workspaces

Provides information about the current workspaces and allows switching between them.

WindowTitle

Displays the title of the currently focused window.

SystemInfo

Displays system information such as CPU usage, memory usage, and disk space.

KeyboardLayout

Displays the current keyboard layout and allows switching between layouts.

KeyboardSubmap

Displays the current keyboard submap.

CustomModule

Allows creating custom modules with user-defined functionality. See the custom module documentation for details.

Tray

Displays system tray icons and menus for applications.

Clock

Displays the current time and date.

Privacy

Provides privacy-related features, such as toggling microphone and camera access.

MediaPlayer

Displays media player controls and information about the currently playing media.

Settings

Provides access to system settings like audio, network, Bluetooth, battery, power profile, and idle inhibitor.