@ni-web-infra/common-utils/types/lib/dom.d.ts

NI util function library

/**
 * 获取当前document对象
 * @function getDocument
 *
 * @returns { Document } DOM对象
 */
export declare const getDocument: () => Document;
/**
 * 生成DOM元素对象
 * @function createDom
 *
 * @param {string} tagName 标签名称
 * @param {string} className class名称
 * @param {string} cssText css样式
 * @returns { HTMLElement } DOM元素对象
 */
export declare const createDom: (tagName: string, className?: string, cssText?: string) => HTMLElement;
/**
 * 删除DOM元素对象
 * @function removeDom
 *
 * @param {Element} el 要素
 */
export declare const removeDom: (el: Element) => void;
/**
 * 增加DOM对象的class
 * @function addClassName
 *
 * @param {Element} el 要素
 * @param {string[]} className class名称
 */
export declare const addClassName: (el: Element, ...className: string[]) => void;
/**
 * 删除DOM对象的class
 * @function removeClassName
 *
 * @param {Element} el 要素
 * @param {string[]} className class名称
 */
export declare const removeClassName: (el: Element, ...className: string[]) => void;
/**
 * 根据class名称删除多个DOM对象的class
 * @function removeClassNameByClassName
 *
 * @param {string} className class名称
 * @param {Document} doc DOM对象
 * @returns { HTMLElement | null } DOM元素对象
 */
export declare const removeClassNameByClassName: (className: string, doc?: Document) => HTMLElement | null;
/**
 * 增加document对象的内联样式
 * @function injectStyle
 *
 * @param {string} style css样式
 * @param {Document} doc DOM对象
 * @returns { HTMLStyleElement } DOM对象的内联样式
 */
export declare const injectStyle: (style: string, doc?: Document) => HTMLStyleElement;
/**
 * 生成过滤XSS的转义字符
 * @function filterXSS
 *
 * @param {string} str 字符
 * @returns { string } 转义后字符
 */
export declare const filterXSS: (str: string) => string;