Skip to content

Type Editor


Type Editor / @type-editor/dom-util / is-on-edge / isOnEdge

Function: isOnEdge()

ts
function isOnEdge(node, offset, parent): boolean;

Defined in: is-on-edge.ts:22

Checks if a position is at the start or end edge of a parent node.

Traverses up the DOM tree from the given position to determine if it represents the very beginning or end of the parent node's content.

Parameters

ParameterTypeDescription
nodeNodeThe starting DOM node
offsetnumberThe offset within the starting node
parentNodeThe parent node to check against

Returns

boolean

True if the position is at the edge of the parent, false otherwise

Example

typescript
const textNode = document.createTextNode("Hello");
const parent = textNode.parentNode;
const isEdge = isOnEdge(textNode, 0, parent); // True if at start