utils/dom¶

Functions¶

onDOMReady()¶

function onDOMReady(callback): void;

Defined in: utils/dom.ts:5

DOM helpers used across UI managers.

Parameters¶

callback¶

() => void

Returns¶

void

escapeHtml()¶

function escapeHtml(text): string;

Defined in: utils/dom.ts:18

Escape a string for safe interpolation into HTML. Escapes the five characters significant in HTML text and quoted-attribute contexts, so the result is safe in both <span>${x}</span> and data-foo="${x}".

Parameters¶

text¶

string

Returns¶

string

getElements()¶

function getElements<T>(ids): { [K in string | number | symbol]: HTMLElement | null };

Defined in: utils/dom.ts:31

Look up multiple elements by id in one call. Keys preserve the caller's naming; values may be null if not found.

Type Parameters¶

T¶

T extends Record\<string, string>

Parameters¶

ids¶

T

Returns¶

{ [K in string | number | symbol]: HTMLElement | null }

setDisabled()¶

function setDisabled(element, disabled): void;

Defined in: utils/dom.ts:45

Apply the "disabled" visual convention used throughout the app: sets the disabled attribute, toggles the disabled class, and updates opacity/cursor.

Parameters¶

element¶

HTMLElement

disabled¶

boolean

Returns¶

void

setVisible()¶

function setVisible(element, visible): void;

Defined in: utils/dom.ts:57

Toggle visibility via display: none / '' (restores the stylesheet default).

Parameters¶

element¶

HTMLElement

visible¶

boolean

Returns¶

void

isVisible()¶

function isVisible(element): boolean;

Defined in: utils/dom.ts:64

True if element is currently rendered (display !== 'none').

Parameters¶

element¶

HTMLElement | null

Returns¶

boolean

setCheckbox()¶

function setCheckbox(id, checked): void;

Defined in: utils/dom.ts:76

Null-safe form-control setters. Each looks up the element by id and applies the value if present. Used to collapse the repetitive const x = document.getElementById('id') as HTMLXElement; if (x) x.checked / x.value / x.textContent = v; pattern that pervades settings-load code.

Parameters¶

id¶

string

checked¶

boolean

Returns¶

void

setInputValue()¶

function setInputValue(id, value): void;

Defined in: utils/dom.ts:81

Parameters¶

id¶

string

value¶

string | number

Returns¶

void

setSelectValue()¶

function setSelectValue(id, value): void;

Defined in: utils/dom.ts:89

Parameters¶

id¶

string

value¶

string

Returns¶

void

setText()¶

function setText(id, text): void;

Defined in: utils/dom.ts:94

Parameters¶

id¶

string

text¶

string

Returns¶

void

isTextEntryTarget()¶

function isTextEntryTarget(target): boolean;

Defined in: utils/dom.ts:105

True if the event originated in a text-entry element (input, textarea, select, or contenteditable). Document-level key handlers use this to leave keystrokes meant for a focused field alone - e.g. Enter/Escape typed in the console must not finish or cancel an in-progress map draw.

Parameters¶

target¶

EventTarget | null

Returns¶

boolean

bindEvent()¶

function bindEvent(
   id, 
   event, 
   handler, 
   options?): boolean;

Defined in: utils/dom.ts:119

Look up an element by id and attach an event listener if it exists. Returns true if the listener was bound (the element was found).

Parameters¶

id¶

string

event¶

string

handler¶

EventListener

options?¶

boolean | AddEventListenerOptions

Returns¶

boolean