Quickshell

building blocks for your desktop

Configuration by end_4 (install)

Configuration by outfoxxed (source code)

Configuration by pfaj and bdebiase

Configuration by vaxry

Quickshell is a toolkit for building status bars, widgets, lockscreens, and other desktop components using QtQuick. It can be used alongside your wayland compositor or window manager to build a complete desktop environment.

More information

Install

Documentation

See your changes in real time
Quickshell loads changes as soon as they're saved, letting you iterate as fast as you can type.

Easy to use language

Quickshell is configured in QML, a simple language designed for creating flexible user interfaces. It also has LSP support.

// a standard desktop window
FloatingWindow {
  Timer {
    // assign an id to the object, which can be
    // used to reference it
    id: timer
    property bool invert: false // a custom property

    // change the value of invert every half second
    running: true; repeat: true
    interval: 500 // ms
    onTriggered: timer.invert = !timer.invert
  }

  // change the window's color when timer.invert changes
  color: timer.invert ? "purple" : "green"
}

// a standard desktop window
FloatingWindow {
  Timer {
    // assign an id to the
    // object, which can be
    // used to reference it
    id: timer
    // a custom property
    property bool invert: false

    // change the value of invert
    // every half second
    running: true; repeat: true
    interval: 500 // ms
    onTriggered: {
      timer.invert = !timer.invert
    }
  }

  // change the window's color
  // when timer.invert changes
  color: timer.invert
    ? "purple"
    : "green"
}

Extensive integrations
Quickshell comes with a large set of integrations, with new ones arriving all the time.