utils

Selkies-specific utilities shared by the dashboard's panels and layouts.

Storage keys: every localStorage key is prefixed with the storage namespace the streaming cores derive from the page URL (lib/util.js), and the per-display settings gain a _display2 suffix on the secondary display, selected by the #display2 URL hash. The route prefix is the cores' derivation too, so the dashboard and both cores agree on all of them.

Core state cache: the core broadcasts serverSettings once per connection and clipboardContentUpdate, effectiveCursorState, and audioDeviceSelected only when something changes, but a panel mounts when its menu or section opens, after those messages. The latest of each is cached at module scope so a late mount can seed its state synchronously; the panels' own listeners still pick up later messages.

InterfacesCopy Anchor Link

ServerSettingCopy Anchor Link

Defined in: utils.ts:79

The server's description of one setting in the serverSettings payload.

PropertiesCopy Anchor Link

value?Copy Anchor Link

value?: unknown;

Defined in: utils.ts:80

locked?Copy Anchor Link

locked?: boolean;

Defined in: utils.ts:81

overridden?Copy Anchor Link

overridden?: boolean;

Defined in: utils.ts:82

allowed?Copy Anchor Link

allowed?: string[];

Defined in: utils.ts:83

min?Copy Anchor Link

min?: number;

Defined in: utils.ts:84

max?Copy Anchor Link

max?: number;

Defined in: utils.ts:85

default?Copy Anchor Link

default?: unknown;

Defined in: utils.ts:86

PrintJobCopy Anchor Link

Defined in: utils.ts:93

A document printed in the session, as the core hands it over: a blob URL.

PropertiesCopy Anchor Link

nameCopy Anchor Link

name: string;

Defined in: utils.ts:93

urlCopy Anchor Link

url: string;

Defined in: utils.ts:93

ClipboardPreviewCopy Anchor Link

Defined in: utils.ts:96

The server clipboard preview; a secret arrives as the flag alone, never its text.

PropertiesCopy Anchor Link

textCopy Anchor Link

text: string;

Defined in: utils.ts:96

truncatedCopy Anchor Link

truncated: boolean;

Defined in: utils.ts:96

secretCopy Anchor Link

secret: boolean;

Defined in: utils.ts:96

Type AliasesCopy Anchor Link

ServerSettingsCopy Anchor Link

type ServerSettings = Record<string, any>;

Defined in: utils.ts:90

The serverSettings payload: untyped JSON keyed by setting name.

CoreMessageCopy Anchor Link

type CoreMessage = Record<string, any>;

Defined in: utils.ts:99

A message the core posts to the page's window (or the page to itself): an object with a type.

RenderableCopy Anchor Link

type Renderable = Record<string, boolean>;

Defined in: utils.ts:185

Every visibility flag the panels and layouts read, from computeRenderableSettings.

VariablesCopy Anchor Link

displayIdCopy Anchor Link

const displayId: "display2" | "primary";

Defined in: utils.ts:50

Which display this page is, from the #display2 URL hash.

isSecondaryDisplayCopy Anchor Link

const isSecondaryDisplay: boolean;

Defined in: utils.ts:51

isViewerUrlModeCopy Anchor Link

const isViewerUrlMode: boolean;

Defined in: utils.ts:58

Viewer-designated URL modes, known before the server answers with a role. The control UI keys off this for its first render so a shared viewer never sees controls it cannot use in the gap before clientRoleUpdate arrives.

isMobileClientCopy Anchor Link

const isMobileClient: boolean;

Defined in: ../../selkies-web-core/lib/util.js:561

Whether the client is touch-first: its primary pointer is coarse. True on phones and tablets, false on desktops -- including touch-screen laptops, whose primary pointer is still the pointing device. The form factor is fixed for the life of the document, so it is resolved once and available to every first render; a touch-capable device this misses is still caught by the first touchstart.

FunctionsCopy Anchor Link

getPrefixedKey()Copy Anchor Link

function getPrefixedKey(key): string;

Defined in: utils.ts:64

The localStorage key for a setting on this display.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

string

storedBool()Copy Anchor Link

function storedBool(key, fallback): boolean;

Defined in: utils.ts:73

Reads a stored boolean, fallback where nothing is stored.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

onCoreMessage()Copy Anchor Link

function onCoreMessage(handler): () => void;

Defined in: utils.ts:106

Hands handler every message the core posts to this window: from this origin, and an object, which is what every message of the core's is.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

The unsubscribe, for an effect's cleanup.

() => void

getPrintJobs()Copy Anchor Link

function getPrintJobs(): PrintJob[];

Defined in: utils.ts:141

The documents printed so far this page; printJobsChanged fires on each.

ReturnsCopy Anchor Link

PrintJob[]

getLastServerSettings()Copy Anchor Link

function getLastServerSettings(): ServerSettings;

Defined in: utils.ts:146

The last serverSettings payload, or null before the first connection.

ReturnsCopy Anchor Link

ServerSettings

getLastClipboardContent()Copy Anchor Link

function getLastClipboardContent(): ClipboardPreview;

Defined in: utils.ts:151

The last server clipboard preview; the core emits it only on clipboard events.

ReturnsCopy Anchor Link

ClipboardPreview

getLastEffectiveCursorState()Copy Anchor Link

function getLastEffectiveCursorState(): boolean;

Defined in: utils.ts:159

The cursor mode actually in effect (multi-monitor forces browser cursors on), emitted at connect and display-config time.

ReturnsCopy Anchor Link

boolean

getLastAudioDevices()Copy Anchor Link

function getLastAudioDevices(): object;

Defined in: utils.ts:168

The dashboard's own audio device picks, which the core keeps for the life of the page; a remounted panel shows them again instead of pretending the defaults are in use.

ReturnsCopy Anchor Link

object

inputCopy Anchor Link

input: string;

outputCopy Anchor Link

output: string;

isSettingRenderable()Copy Anchor Link

function isSettingRenderable(setting): boolean;

Defined in: utils.ts:176

Whether a control is worth rendering: the user can actually change it, meaning not locked and with more than one permitted value.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

computeRenderableSettings()Copy Anchor Link

function computeRenderableSettings(serverSettings): Renderable;

Defined in: utils.ts:194

Derives every visibility flag the panels read from a serverSettings payload: the admin's ui_* toggles, per-control renderability from each setting's own constraints, the sharing roles, the stream-control menu entries, and the file-transfer directions. Every flag defaults to shown before the payload arrives, except those an absent server cannot offer.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Renderable

hint()Copy Anchor Link

function hint(label, detail?): string;

Defined in: utils.ts:279

The hover text of a labeled control: its label, then its detail after a colon where it has one, so a label the row cut short still reads whole.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

string

hardwareKeyboard()Copy Anchor Link

function hardwareKeyboard(): object;

Defined in: ../../selkies-web-core/lib/hardware-keyboard.js:119

The page's watch, listening from its first use: keydowns and touches on the window in the capture phase, before the stream's own handlers take them, and on a touch screen the primary pointer.

ReturnsCopy Anchor Link

attachedCopy Anchor Link

attached: () => boolean;

ReturnsCopy Anchor Link

boolean

Whether a keyboard is taken to be attached.

onKeyDown()Copy Anchor Link

onKeyDown(event): void;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

onTouch()Copy Anchor Link

onTouch(): void;

ReturnsCopy Anchor Link

void

onPointer()Copy Anchor Link

onPointer(fine): void;

The primary pointer of a touch screen turned fine, a keyboard attached with its touchpad, or coarse, the keyboard gone with the keys it typed.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

reset()Copy Anchor Link

reset(): void;

Forgets the verdict until the next keyboard-only key or pointer change, as when the user asks for the button back.

ReturnsCopy Anchor Link

void

subscribe()Copy Anchor Link

subscribe(fn): () => void;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Unsubscribes.

() => void

getRoutePrefix()Copy Anchor Link

function getRoutePrefix(): string;

Defined in: ../../selkies-web-core/lib/util.js:392

Directory this document is served from, without a trailing slash ('' at the server root). Every request the client builds hangs off it, so a deployment reverse-proxied under a subfolder reaches its own routes, and an iframed client reads its own path instead of the frame's.

ReturnsCopy Anchor Link

string

The path prefix, e.g. /desk.

getStorageAppName()Copy Anchor Link

function getStorageAppName(): string;

Defined in: ../../selkies-web-core/lib/util.js:448

The localStorage namespace every stored key is prefixed with.

Origin and pathname only, not the full URL: a per-session ?token= must not mint a new namespace on each connect. Cores and dashboards share one prefix, so this derivation is the single one they all call.

ReturnsCopy Anchor Link

string

Sanitized namespace, empty outside a browser.