Skip to main content

Function: pinLabelFor()

function pinLabelFor(record: Pick<WindowRecord, "dockMode" | "dragging">): "PIN" | "UNPIN";

Defined in: core/window-manager.ts:99

What the pin affordance should read for a window's current state:

  • dragging → "PIN" (the window is loose in your hand)
  • placed/world-locked → "UNPIN" (click releases it to follow)
  • following → "PIN" (click pins it where it is)

Parameters​

ParameterType
recordPick<WindowRecord, "dockMode" | "dragging">

Returns​

"PIN" | "UNPIN"