Inhibit

Tip

Inhibit is tracked globally (system-wide). Multiple inhibit modules share the same inhibit state.

Prevents the compositor from auto-suspending the system or auto-locking the screen. Click to toggle inhibit on/off or cycle through preset durations.

Example

Corn

{
  end = [
    {
      type = "inhibit"
      durations = ["00:30:00" "01:00:00" "01:30:00" "02:00:00" "inf"]
      default_duration = "00:30:00"
      on_click_left = "toggle"
      on_click_right = "cycle"
      format_on = "☕ {duration}"
      format_off = "💤 {duration}"
    }
  ]
}

JSON

{
  "end": [
    {
      "type": "inhibit",
      "durations": [
        "00:30:00",
        "01:00:00",
        "01:30:00",
        "02:00:00",
        "inf"
      ],
      "default_duration": "00:30:00",
      "on_click_left": "toggle",
      "on_click_right": "cycle",
      "format_on": "☕ {duration}",
      "format_off": "💤 {duration}"
    }
  ]
}

YAML

end:
  - type: inhibit
    durations:
      - 00:30:00
      - 01:00:00
      - 01:30:00
      - 02:00:00
      - inf
    default_duration: 00:30:00
    on_click_left: toggle
    on_click_right: cycle
    format_on: ☕ {duration}
    format_off: 💤 {duration}

TOML

[[end]]
type = "inhibit"
durations = [ "00:30:00", "01:00:00", "01:30:00", "02:00:00", "inf" ]
default_duration = "00:30:00"
on_click_left = "toggle"
on_click_right = "cycle"
format_on = "☕ {duration}"
format_off = "💤 {duration}"

Configuration

Type: inhibit

default_durationRequired

No description provided.

Type: string
Default: None

durationsRequired

No description provided.

Type: Array (string)
Default: None

format_off

Format string when inhibit is inactive. {duration} token shows selected duration.

Type: string
Default: 💤 {duration}

format_on

Format string when inhibit is active. {duration} token shows remaining/selected time.

Type: string
Default: ☕ {duration}

justify

The justification (alignment) of the widget text shown on the bar.

Type: 'left' | 'right' | 'center' | 'fill'
Default: 'left'

orientation

The orientation to display the widget contents. Setting to vertical will rotate text 90 degrees.

Type: 'horizontal' | 'vertical'
Default: 'horizontal'

Styling

Selector	Description
.inhibit	Inhibit widget button

For more information on styling, please see the styling guide.