@mirawision/domino/element.d.ts

Lightweight DOM utilities for Chrome Extension content scripts

import { HTMLOptions } from './types';
/**
 * Updates the class list of a DOM element by adding and/or removing specified classes.
 *
 * @param el - The DOM element to update classes on
 * @param options - Object containing classes to add and/or remove
 * @param options.add - Array of class names to add to the element
 * @param options.remove - Array of class names to remove from the element
 *
 * @example
 * ```typescript
 * const element = document.querySelector('.my-element');
 * setClasses(element, {
 *   add: ['active', 'visible'],
 *   remove: ['hidden']
 * });
 * ```
 */
export declare function setClasses(el: Element, { add, remove }: {
    add?: string[];
    remove?: string[];
}): void;
/**
 * Sets or removes attributes on a DOM element.
 * If an attribute value is undefined, the attribute will be removed.
 *
 * @param el - The DOM element to update attributes on
 * @param attrs - Object mapping attribute names to their values
 *
 * @example
 * ```typescript
 * const element = document.querySelector('.my-element');
 * setAttributes(element, {
 *   'aria-label': 'Close button',
 *   'disabled': undefined // This will remove the disabled attribute
 * });
 * ```
 */
export declare function setAttributes(el: Element, attrs: Record<string, string | undefined>): void;
/**
 * Sets the text content of a DOM element.
 * This is safer than setting innerHTML as it automatically escapes HTML.
 *
 * @param el - The DOM element to update text content on
 * @param text - The text content to set
 *
 * @example
 * ```typescript
 * const element = document.querySelector('.my-element');
 * setText(element, 'Hello World!');
 * ```
 */
export declare function setText(el: Element, text: string): void;
/**
 * Sets the HTML content of a DOM element with optional sanitization.
 *
 * @param el - The DOM element to update HTML content on
 * @param html - The HTML string to set
 * @param options - Configuration options
 * @param options.sanitize - Optional function to sanitize the HTML string before setting
 *
 * @example
 * ```typescript
 * const element = document.querySelector('.my-element');
 * setHTML(element, '<p>Hello <strong>World!</strong></p>', {
 *   sanitize: (html) => DOMPurify.sanitize(html)
 * });
 * ```
 */
export declare function setHTML(el: Element, html: string, options?: HTMLOptions): void;