Module blocks

Source
Expand description

The collection of blocks

Blocks are defined as a TOML array of tables: [[block]]

KeyDescriptionDefault
blockName of the i3status-rs block you want to use. See modules below for valid block names.-
signalSignal value that causes an update for this block with 0 corresponding to -SIGRTMIN+0 and the largest value being -SIGRTMAXNone
if_commandOnly display the block if the supplied command returns 0 on startup.None
merge_with_nextIf true this will group the block with the next one, so rendering such as alternating_tint will apply to the whole groupfalse
icons_formatOverrides global icons_formatNone
error_formatOverrides global error_formatNone
error_fullscreen_formatOverrides global error_fullscreen_formatNone
error_intervalHow long to wait until restarting the block after an error occurred.5
[block.theme_overrides]Same as the top-level config option, but for this block only. Refer to Themes and Icons below.None
[block.icons_overrides]Same as the top-level config option, but for this block only. Refer to Themes and Icons below.None
[[block.click]]Set or override click action for the block. See below for details.Block default / None

Per block click configuration [[block.click]]:

KeyDescriptionDefault
buttonleft, middle, right, up/wheel_up, down/wheel_down, wheel_left, wheel_right, forward, back or double_left.-
widgetTo which part of the block this entry applies (accepts regex)"block"
cmdCommand to run when the mouse button event is detected.None
actionWhich block action to triggerNone
syncWhether to wait for command to exit or not.false
updateWhether to update the block on click.false

Modules§

amd_gpu
Display the stats of your AMD GPU
backlight
The brightness of a backlight device
battery
Information about the internal power supply
bluetooth
Monitor Bluetooth device
calendar
Calendar
cpu
CPU statistics
custom
The output of a custom shell command
custom_dbus
A block controlled by the DBus
disk_iostats
Disk I/O statistics
disk_space
Disk usage statistics
docker
Local docker daemon status
external_ip
External IP address and various information about it
focused_window
Currently focused window
github
The number of GitHub notifications
hueshift
Manage display temperature
kdeconnect
KDEConnect indicator
keyboard_layout
Keyboard layout indicator
load
System load average
maildir
Unread mail. Only supports maildir format.
memory
Memory and swap usage
menu
A custom menu
music
The current song title and artist
net
Network information
notify
Display and toggle the state of notifications daemon
notmuch
Count of notmuch messages
nvidia_gpu
Display the stats of your NVidia GPU
packages
Pending updates for different package manager like apt, pacman, etc.
pomodoro
A pomodoro timer
privacy
Privacy Monitor
rofication
The number of pending notifications in rofication-daemon
scratchpad
Scratchpad indicator
service_status
Display the status of a service
sound
Volume level
speedtest
Ping, download, and upload speeds
taskwarrior
The number of tasks from the taskwarrior list
tea_timer
Timer
temperature
The system temperature
time
The current time.
toggle
A Toggle block
uptime
System’s uptime
vpn
Shows the current connection status for VPN networks
watson
Watson statistics
weather
Current weather
xrandr
X11 screen information

Structs§

BlockError
An error which originates from a block
CommonApi

Enums§

BlockConfig

Type Aliases§

BlockAction