Quickshell

Types

PanelWindow: QsWindow

import Quickshell

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!"
  }
}
  • aboveWindows :  bool

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

    Note: On Wayland this property corrosponds to Go to WlrLayershell.layer.

  • anchors :  [top,bottom,left,right]

    Property top:bool Property bottom:bool Property left:bool Property right: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.

    NOTE

    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 Go to exclusionMode to ExclusionMode.Normal.

    NOTE

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

  • focusable :  bool

    If the panel should accept keyboard focus. Defaults to false.

    Note: On Wayland this property corrosponds to Go to WlrLayershell.keyboardFocus.

  • margins :  [left,right,bottom,top]

    Property left:int Property right:int Property bottom:int Property top:int

    Offsets from the sides of the screen.

    NOTE

    Only applies to edges with anchors