Quickshell Docs

Getting Started Intro Positioning QML Overview

Quickshell Types

BoundComponent 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 ShellRoot ShellScreen Singleton SystemClock TransformWatcher Variants

Quickshell.DBusMenu

DBusMenuHandle DBusMenuItem

Quickshell.Hyprland

GlobalShortcut Hyprland HyprlandEvent HyprlandFocusGrab HyprlandMonitor HyprlandWorkspace

I3 I3Event I3Monitor I3Workspace

DataStream DataStreamParser FileView FileViewError IpcHandler Process Socket SocketServer SplitParser

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 PwObjectTracker

Quickshell.Services.SystemTray

Category Status SystemTray SystemTrayItem

Quickshell.Services.UPower

UPower UPowerDevice UPowerDeviceState UPowerDeviceType

Quickshell.Wayland

Toplevel ToplevelManager WlSessionLock WlSessionLockSurface WlrKeyboardFocus WlrLayer WlrLayershell

Quickshell.Widgets

ClippingRectangle ClippingWrapperRectangle IconImage MarginWrapperManager WrapperItem WrapperManager WrapperRectangle

Quickshell Examples

Quickshell

Contents

Getting Started Intro Positioning QML Overview

Quickshell Types

BoundComponent 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 ShellRoot ShellScreen Singleton SystemClock TransformWatcher Variants

Quickshell.DBusMenu

DBusMenuHandle DBusMenuItem

Quickshell.Hyprland

GlobalShortcut Hyprland HyprlandEvent HyprlandFocusGrab HyprlandMonitor HyprlandWorkspace

I3 I3Event I3Monitor I3Workspace

DataStream DataStreamParser FileView FileViewError IpcHandler Process Socket SocketServer SplitParser

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 PwObjectTracker

Quickshell.Services.SystemTray

Category Status SystemTray SystemTrayItem

Quickshell.Services.UPower

UPower UPowerDevice UPowerDeviceState UPowerDeviceType

Quickshell.Wayland

Toplevel ToplevelManager WlSessionLock WlSessionLockSurface WlrKeyboardFocus WlrLayer WlrLayershell

Quickshell.Widgets

ClippingRectangle ClippingWrapperRectangle IconImage MarginWrapperManager WrapperItem WrapperManager WrapperRectangle

Quickshell Examples

Docs

Docs

Configuration

Type Definitions

Brought to you by:

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