WlSessionLockSurface

WlSessionLockSurface: Reloadable

import Quickshell.Wayland

Surface to display with a WlSessionLock. More

Properties

Detailed Description

Surface displayed by a WlSessionLock when it is locked.

Property Details

color: color

The background color of the window. Defaults to white.

⚠️

This seems to behave weirdly when using transparent colors on some systems. Using a colored content item over a transparent window is the recommended way to work around this:

ProxyWindow {
  Rectangle {
    anchors.fill: parent
    color: "#20ffffff"

    // your content here
  }
}

… but you probably shouldn’t make a transparent lock, and most compositors will ignore an attempt to do so.

[readonly]

contentItem: Item

No details provided.

[default, readonly]

data: list<QtObject>

No details provided.

[readonly]

height: int

No details provided.

[readonly]

screen: ShellScreen

The screen that the surface is displayed on.

[readonly]

visible: bool

If the surface has been made visible.

Note: SessionLockSurfaces will never become invisible, they will only be destroyed.

[readonly]

width: int

No details provided.