Skip to content

Displays Module

Sam edited this page Aug 7, 2024 · 1 revision

The displays module outputs information about your connected monitors and their configuration. It fetches this information from your X11/Wayland compositor. It creates a new line for each display.

Using

Insert into the modules array.

Configuration

  • title -> (String) The module title for each monitor. Check below to see available placeholders.
  • format -> (String) The format used for each monitor. Check below to see available placeholders.
  • scale_size -> (Bool) Whether to scale the resolution according to your monitor's set scale or not. Disable this if you use fractional scaling.
  • title_color -> (Optional/String) Override the title color to be used.
  • title_bold -> (Optional/Bool) Make the title bold.
  • title_italic -> (Optional/Bool) Make the title italic.
  • separator -> (Optional/Char) Override the separator to be used.
title placeholders;
  • {make} -> The 3 character ID of the manufacturer of the display.
  • {model} -> The model of the display.
  • {name} -> The display's DRM name e.g DP-2.
format placeholders;
  • {make} -> The 3 character ID of the manufacturer of the display.
  • {model} -> The model of the display.
  • {name} -> The display's DRM name e.g DP-2.
  • {width} -> The width of the resolution as it's currently configured to display at.
  • {height} -> The height of the resolution as it's currently configured to display at.
  • {refresh_rate} -> The refresh rate the monitor runs at. This is not available on X11, due to it's lack of per-display refresh rates.
Default Configuration
[displays]
title = "Display ({make} {model})"
format = "{width}x{height} @ {refresh_rate}Hz ({name})"
scale_size = false

Example

modules = [
    "displays"
]

[displays]
title = "{name} ({make} {model})"
format = "{width}x{height} @ {refresh_rate}Hz"
scale_size = false