package.src.dom-utils.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of component-base Show documentation

Vaadin component base mixins

There is a newer version: 24.5.3

/**
 * @license
 * Copyright (c) 2021 - 2024 Vaadin Ltd.
 * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
 */

/**
 * Returns an array of ancestor root nodes for the given node.
 *
 * A root node is either a document node or a document fragment node (Shadow Root).
 * The array is collected by a bottom-up DOM traversing that starts with the given node
 * and involves both the light DOM and ancestor shadow DOM trees.
 */
export function getAncestorRootNodes(node: Node): Node[];

/**
 * Returns the list of flattened elements for the given `node`.
 * This list consists of a node's children and, for any children that are
 * `` elements, the expanded flattened list of `assignedElements`.
 */
export function getFlattenedElements(node: Node): Element[];

/**
 * Traverses the given node and its parents, including those that are across
 * the shadow root boundaries, until it finds a node that matches the selector.
 */
export function getClosestElement(selector: string, node: Node): Node | null;

/**
 * Takes a string with values separated by space and returns a set the values
 */
export function deserializeAttributeValue(value: string): Set;

/**
 * Takes a set of string values and returns a string with values separated by space
 */
export function serializeAttributeValue(values: Set): string;

/**
 * Adds a value to an attribute containing space-delimited values.
 */
export function addValueToAttribute(element: HTMLElement, attr: string, value: string): void;

/**
 * Removes a value from an attribute containing space-delimited values.
 * If the value is the last one, the whole attribute is removed.
 */
export function removeValueFromAttribute(element: HTMLElement, attr: string, value: string): void;

/**
 * Returns true if the given node is an empty text node, false otherwise.
 */
export function isEmptyTextNode(node: Node): boolean;