Quickshell Docs

BoundComponent ColorQuantizer DesktopAction DesktopEntries DesktopEntry EasingCurve Edges ElapsedTimer ExclusionMode FloatingWindow Intersection LazyLoader ObjectModel ObjectRepeater PanelWindow PersistentProperties PopupAdjustment PopupAnchor PopupWindow QsMenuAnchor QsMenuButtonType QsMenuEntry QsMenuHandle QsMenuOpener QsWindow Quickshell QuickshellSettings Region RegionShape Reloadable Retainable RetainableLock Scope ScriptModel ShellRoot ShellScreen Singleton SystemClock TransformWatcher Variants

Quickshell.DBusMenu

DBusMenuHandle DBusMenuItem

Quickshell.Hyprland

GlobalShortcut Hyprland HyprlandEvent HyprlandFocusGrab HyprlandMonitor HyprlandToplevel HyprlandWindow HyprlandWorkspace

Quickshell.I3

I3 I3Event I3Monitor I3Workspace

Quickshell.Io

DataStream DataStreamParser FileView FileViewAdapter FileViewError IpcHandler JsonAdapter JsonObject Process Socket SocketServer SplitParser StdioCollector

Quickshell.Services.Greetd

Greetd GreetdState

Quickshell.Services.Mpris

Mpris MprisLoopState MprisPlaybackState MprisPlayer

Quickshell.Services.Notifications

Notification NotificationAction NotificationCloseReason NotificationServer NotificationUrgency

Quickshell.Services.Pam

PamContext PamError PamResult

Quickshell.Services.Pipewire

Pipewire PwAudioChannel PwLink PwLinkGroup PwLinkState PwNode PwNodeAudio PwNodeLinkTracker PwNodeType PwObjectTracker

Quickshell.Services.SystemTray

Category Status SystemTray SystemTrayItem

Quickshell.Services.UPower

PerformanceDegradationReason PowerProfile PowerProfiles UPower UPowerDevice UPowerDeviceState UPowerDeviceType

Quickshell.Wayland

ScreencopyView Toplevel ToplevelManager WlSessionLock WlSessionLockSurface WlrKeyboardFocus WlrLayer WlrLayershell

Quickshell.Widgets

ClippingRectangle ClippingWrapperRectangle IconImage MarginWrapperManager WrapperItem WrapperManager WrapperMouseArea WrapperRectangle

QtQuick Types

Quickshell Examples

Quickshell

Docs Version: Master Branch (Switch) About Quickshell

Usage Guide

Installation & Setup Introduction Item Size and Position Distributing Configurations QML Language FAQ

Quickshell Types

Quickshell

BoundComponent ColorQuantizer DesktopAction DesktopEntries DesktopEntry EasingCurve Edges ElapsedTimer ExclusionMode FloatingWindow Intersection LazyLoader ObjectModel ObjectRepeater PanelWindow PersistentProperties PopupAdjustment PopupAnchor PopupWindow QsMenuAnchor QsMenuButtonType QsMenuEntry QsMenuHandle QsMenuOpener QsWindow Quickshell QuickshellSettings Region RegionShape Reloadable Retainable RetainableLock Scope ScriptModel ShellRoot ShellScreen Singleton SystemClock TransformWatcher Variants

Quickshell.DBusMenu

DBusMenuHandle DBusMenuItem

Quickshell.Hyprland

GlobalShortcut Hyprland HyprlandEvent HyprlandFocusGrab HyprlandMonitor HyprlandToplevel HyprlandWindow HyprlandWorkspace

Quickshell.I3

I3 I3Event I3Monitor I3Workspace

Quickshell.Io

DataStream DataStreamParser FileView FileViewAdapter FileViewError IpcHandler JsonAdapter JsonObject Process Socket SocketServer SplitParser StdioCollector

Quickshell.Services.Greetd

Greetd GreetdState

Quickshell.Services.Mpris

Mpris MprisLoopState MprisPlaybackState MprisPlayer

Quickshell.Services.Notifications

Notification NotificationAction NotificationCloseReason NotificationServer NotificationUrgency

Quickshell.Services.Pam

PamContext PamError PamResult

Quickshell.Services.Pipewire

Pipewire PwAudioChannel PwLink PwLinkGroup PwLinkState PwNode PwNodeAudio PwNodeLinkTracker PwNodeType PwObjectTracker

Quickshell.Services.SystemTray

Category Status SystemTray SystemTrayItem

Quickshell.Services.UPower

PerformanceDegradationReason PowerProfile PowerProfiles UPower UPowerDevice UPowerDeviceState UPowerDeviceType

Quickshell.Wayland

ScreencopyView Toplevel ToplevelManager WlSessionLock WlSessionLockSurface WlrKeyboardFocus WlrLayer WlrLayershell

Quickshell.Widgets

ClippingRectangle ClippingWrapperRectangle IconImage MarginWrapperManager WrapperItem WrapperManager WrapperMouseArea WrapperRectangle

QtQuick Types

Quickshell Examples

Docs

Docs

Usage Guide

Type Definitions

Brought to you by:

outfoxxed - Lead Developer xanazf - Website Developer / Designer and our contributors