Primitives / API

foldkit-primitives/dom

Functions

`applyMask`	The mask as a pure function: # takes a digit, A a letter, * either, and any other character of the pattern is written in once input reaches past it. Input…
`boxOf`	An element's box. An element drawn as display: contents has none, so its first child's stands for it, as an editor's node wrapper's does.
`copyText`	Copies text to the clipboard. Without a clipboard API (SSR, insecure context, denied permission) the command yields CopyFailed instead of throwing, so…
`fluidHovered`	The custom properties FluidHover writes on its container for a highlight named name.
`keepScroll`	Keeps the window's scroll across same-document navigations: a pushed entry starts at the top, and Back, Forward or a reload return where that entry was.…
`loadScript`	Loads a script by URL, once per URL.
`measured`	The custom properties Measure writes for a target named name.
`pointedLinks`	The address of the link a reader points at or tabs to, on the page's own origin: where they may go next, for a Data.preload before they go. Each link once…
`readText`	Reads the clipboard's text. The browser may ask the user first; a refusal, an insecure context or no clipboard API yields ReadFailed.
`share`	Shares data through the platform sheet.
`tabbableWithin`	Tabbable descendants in DOM order: focusable, visible, and not tabindex="-1".
`targetOf`	The id of the nearest marked element at or above from, inside container.
`textOf`	A field's text. A browser ends an edited element with a line break it adds itself, which is not the author's; in one line, the author's breaks are spaces.
`zoneOf`	The zone of a box a vertical position falls in, by thirds.

Values

`Autofocus`	Autofocus as a Mount: focuses the element on insert, then emits Focused. The message means focus was requested — a non-focusable element or a hidden tab may…
`ClipboardMessage`
`ClipboardReadMessage`
`DRAG_THRESHOLD`	How far, in CSS pixels, a press moves before it is a drag rather than a click.
`DragCancelled`
`DragDropped`
`DraggedOver`
`DragPlace`	A marked descendant under the pointer, and the zone of it the pointer is in. part is the value of the part attribute on the element found, such as the empty…
`DragStarted`
`DragZone`
`EditableText`	Text typed into an editable descendant of an element, as a Mount: one set of listeners on the container, like Targets. A field is a descendant marked by an…
`EditAsked`
`FLUID_HOVER_ATTRIBUTE`	The attribute FluidHover sets on its container, to the highlight's name, while it runs: a stylist draws the highlight, and drops each item's own hover, only…
`FLUID_LIT_ATTRIBUTE`	The attribute on the item the highlight is shown on, for what CSS draws beside it.
`FLUID_PRESS_ATTRIBUTE`	The attribute that names, inside an item, the control a press in a gap reaches.
`FluidHover`	One highlight that follows the pointer across a container's items, as a Mount, with no Message and no Model: which item the pointer is nearest is…
`Focused`
`FocusScope`	A focus scope as a Mount: on insert it remembers what was focused, focuses an initial element inside, and with contain keeps Tab and Shift+Tab cycling…
`FollowTabStop`	Keeps focus that is inside a container of roving tab stops on its stop, as a Mount: when a transition moves the stop (a row made current by a command the…
`HideOutside`	Makes everything outside the element inert while it is mounted, and restores it after.
`Input`	What InputMask reports after each edit: the masked text shown, and the characters typed.
`InputMask`	An input mask as a Mount plus a pure mask function. The pattern language is three placeholders — # digit, A letter, * either, all ASCII — with every other…
`KeepInView`	Keeps what is marked in view as a Mount: whenever an element in the mounted one's subtree newly matches selector, such as the row just selected in a list,…
`Measure`	Measures marked elements as a Mount, for a view to draw something over them, such as an editor's selection outline, with no Message and no Model: where an…
`Move`	Pointer movement on an element as a Mount: a primary-button pointer down captures the pointer, each move reports the delta from where it started, and up,…
`Moved`
`MoveEnded`
`MoveStarted`
`PointerDrag`	Dragging one marked descendant of an element onto another, as a Mount. A descendant is marked by an attribute whose value is its id, as Targets marks them;…
`ScriptMessage`
`ScrollLock`	Locks the document's scroll while the element is mounted; nested locks release with the last.
`ShareData`
`ShareMessage`
`TargetHovered`
`TargetPressed`
`Targets`	Which marked descendant of an element the pointer is over, and which one was pressed, as a Mount: one set of listeners on the container, not one per item. A…
`TextCancelled`
`TextCommitted`
`TextEdited`

Interfaces

KeepScrollOptions How keepScroll remembers and restores each history entry's offset.

Types

`DragFact`
`Fact`
`FluidAxis`
`TargetFact`
`TextFact`