toolset.io/framework/es/dom.d.ts

前端开发常用工具集。

/**
 * 检索匹配指定选择器的所有元素
 *
 * @param selector 选择器
 * @param root 根元素，不指定时为 `document.body`
 *
 * @returns 匹配的所有元素
 */
export declare function queryAll(selector: string, root?: Element | null): HTMLElement[];
/**
 * 判断指定的元素是否聚焦或包含聚焦的元素
 *
 * @param el 需判断的元素
 *
 * @returns 是否聚焦或包含聚焦的元素
 */
export declare function isFocusIn(el?: Element | null): boolean;
/**
 * 判断一个元素是否包含另一个元素
 *
 * @param el 被包含的元素（子元素）
 * @param parent 包含的元素（父元素）
 *
 * @returns 元素是否包含另一个元素
 */
export declare function contains(el?: Element | null, parent?: HTMLElement | null): boolean;
/**
 * 判断指定的元素是否隐藏
 *
 * @param el 需判断的元素
 *
 * @returns 元素是否隐藏
 */
export declare function isHidden(el?: Element | null): boolean;
/**
 * 判断指定的元素是否可见
 *
 * @param el 需判断的元素
 *
 * @returns 元素是否可见
 */
export declare function isVisible(el?: Element | null): boolean;
/**
 * 判断指定的元素是否被禁用
 *
 * @param el 需判断的元素
 *
 * @returns 元素是否被禁用
 */
export declare function isDisabled(el?: Element | null): boolean;
/**
 * 检索可以被切换焦点（Tab）的元素
 *
 * @param root 根元素，不指定时为 `document.body`
 * @param includeDisabled 是否包含被禁用的元素
 *
 * @returns 可以被切换焦点的元素
 */
export declare function queryTabables(root?: HTMLElement, includeDisabled?: boolean): HTMLElement[];
/**
 * 获取元素横向的内边距像素值
 *
 * @param el 指定的元素
 *
 * @returns 元素横向的内边距像素值
 */
export declare function getXPadding(el: HTMLElement | null): number;
/**
 * 获取元素纵向的内边距像素值
 *
 * @param el 指定的元素
 *
 * @returns 元素纵向的内边距像素值
 */
export declare function getYPadding(el: HTMLElement | null): number;
/**
 * 获取元素横向的外边距像素值
 *
 * @param el 指定的元素
 *
 * @returns 元素横向的外边距像素值
 */
export declare function getXMargin(el: HTMLElement | null): number;
/**
 * 获取元素纵向的外边距像素值
 *
 * @param el 指定的元素
 *
 * @returns 元素纵向的外边距像素值
 */
export declare function getYMargin(el: HTMLElement | null): number;
/**
 * 获取元素横向的边框像素值
 *
 * @param el 指定的元素
 *
 * @returns 元素横向的边框像素值
 */
export declare function getXBorder(el: HTMLElement | null): number;
/**
 * 获取元素纵向的边框像素值
 *
 * @param el 指定的元素
 *
 * @returns 元素纵向的边框像素值
 */
export declare function getYBorder(el: HTMLElement | null): number;
/**
 * 获取元素的选中宽度
 *
 * @param el 指定的元素
 *
 * @returns 元素的选中宽度
 */
export declare function getRangeWidth(el: HTMLElement | null): number;
/**
 * 给定的值如果为合法数字，则将转换为像素值
 *
 * @param value 需要判断的值
 *
 * @returns 转换后的像素值
 */
export declare function toCssSize(value: number | string): string;
/**
 * 将指定的值转换为 HTML 属性值
 *
 * @param value 需要转换的值
 *
 * @returns 转换后的 HTML 属性值
 */
export declare function toAttrValue(value?: boolean | null): 'true' | undefined;
export declare function toAttrValue(value?: string | number | null): string | undefined;