Expand description

Disk usage statistics

§Configuration

KeyValuesDefault
pathPath to collect information from. Supports path expansions e.g. ~."/"
intervalUpdate time in seconds20
formatA string to customise the output of this block. See below for available placeholders." $icon $available "
format_altIf set, block will switch between format and format_alt on every clickNone
warningA value which will trigger warning block state20.0
alertA value which will trigger critical block state10.0
info_typeDetermines which information will affect the block state. Possible values are "available", "free" and "used""available"
alert_unitThe unit of alert and warning options. If not set, percents are used. Possible values are "B", "KB", "KiB", "MB", "MiB", "GB", "Gib", "TB" and "TiB"None
PlaceholderValueTypeUnit
iconA static iconIcon-
pathThe value of path optionText-
percentageFree or used percentage. Depends on info_typeNumber%
totalTotal disk spaceNumberBytes
usedUsed disk spaceNumberBytes
freeFree disk spaceNumberBytes
availableAvailable disk space (free disk space minus reserved system space)NumberBytes
ActionDescriptionDefault button
toggle_formatToggles between format and format_altLeft

§Examples

[[block]]
block = "disk_space"
info_type = "available"
alert_unit = "GB"
alert = 10.0
warning = 15.0
format = " $icon $available "
format_alt = " $icon $available / $total "

Update block on right click:

[[block]]
block = "disk_space"
[[block.click]]
button = "right"
update = true

Show the block only if less than 10GB is available:

[[block]]
block = "disk_space"
format = " $free.eng(range:..10e9) |"

§Icons Used

  • disk_drive

Structs§

Enums§

Functions§