Docs
Type Reference
Quickshell
PanelWindow

PanelWindow: QSWindow

import Quickshell

Decorationless window attached to screen edges by anchors. More

Properties

Detailed Description

Decorationless window attached to screen edges by anchors.

Example

The following snippet creates a white bar attached to the bottom of the screen.

PanelWindow {
  anchors {
    left: true
    bottom: true
    right: true
  }

  Text {
    anchors.centerIn: parent
    text: "Hello!"
  }
}

Property Details

aboveWindows: bool

If the panel should render above standard windows. Defaults to true.

anchors.bottom: bool

anchors.left: bool

anchors.right: bool

anchors.top: bool

Anchors attach a shell window to the sides of the screen. By default all anchors are disabled to avoid blocking the entire screen due to a misconfiguration.

ℹ️
When two opposite anchors are attached at the same time, the corrosponding dimension (width or height) will be forced to equal the screen width/height. Margins can be used to create anchored windows that are also disconnected from the monitor sides.

exclusionMode: ExclusionMode

Defaults to ExclusionMode.Auto.

exclusiveZone: int

The amount of space reserved for the shell layer relative to its anchors. Setting this property sets exclusionMode to Normal.

ℹ️
Either 1 or 3 anchors are required for the zone to take effect.

focusable: bool

Defaults to false.

margins.bottom: int

margins.left: int

margins.right: int

margins.top: int

Offsets from the sides of the screen.

ℹ️
Only applies to edges with anchors
ObjectRepeaterPersistentProperties