phosphor-shell-lock

Lockscreen surface that draws the layout you left as outlines.

The Phosphor.Lock lockscreen. LockSurface is a QQuickWindow marked through phosphor-wayland so the QPA plugin gives it the ext_session_lock_surface_v1 role on its output, and it refuses to show while no session lock is held. LockScreen is one output's content: every window of that screen's placement map drawn at 1:1 as a static spectrum outline, with the clock, date, and password field placed in the largest empty region of the map, or centred when there is no room. One LockController holds the single password behind every screen, so whichever output has keyboard focus feeds the same field. Authentication is not in this library: the shell hands LockController a LockService from phosphor-service-lock, duck-typed so tests can use a fake. On unlock the outlines fill as the real windows come back.

Full API →

Key types

LockSurface
QML window that is one output's session-lock surface; refuses to show without a held lock.
LockScreen
One output's lock content: layout outlines, clock, date, auth field, battery figure.
LockController
The one password behind every screen; submits to the lock service and tracks its state.
LockLayout
The placement map's windows as static outlines, filled on unlock.
LockAuthField
Password field whose edge shows idle, authenticating, and failed states.

Dependencies

See also

References