Hyprland Lua API

hl.dsp.window.pin¶

hl.dsp.window.pin(spec?: table)¶: Pin, unpin, or toggle a window.

Signature¶

hl.dsp.window.pin(spec?: table): HL.Dispatcher

Parameters¶

spectable, optional: Toggle-action table.
windowHL.WindowSelector, optional: Target window where supported.

Returns¶

dispatcherHL.Dispatcher: Dispatcher object returned by this function.

Examples¶

hl.dispatch(hl.dsp.window.pin({ action = "toggle" }))

Notes¶

See also¶

HL.Dispatcher: Dispatcher object returned by this function.
hl.bind(): Bind a dispatcher to a key.
hl.dispatch(): Execute a dispatcher immediately.