z-util-page
Version:
70 lines (69 loc) • 1.7 kB
TypeScript
/**
* @module DomHelper
* @category DOM操作辅助类
*/
/**
* 将可滚动元素滚动到顶部
* @example
* ```ts
* scrollToTop(dom: HTMLElement);
* ```
* @param scroll 要滚动的元素
*/
export declare function scrollToTop(scroll: HTMLElement): void;
/**
* 将可滚动元素滚动到底部
* @example
* ```ts
* scrollToBottom(dom: HTMLElement);
* ```
* @param scroll 要滚动的元素
*/
export declare function scrollToBottom(scroll: HTMLElement): void;
/**
* 将可滚动元素滚动到最左侧
* @example
* ```ts
* scrollToLeft(dom: HTMLElement);
* ```
* @param scroll 要滚动的元素
*/
export declare function scrollToLeft(scroll: HTMLElement): void;
/**
* 将可滚动元素滚动到最右侧
* @example
* ```ts
* scrollToRight(dom: HTMLElement);
* ```
* @param scroll 要滚动的元素
*/
export declare function scrollToRight(scroll: HTMLElement): void;
/**
* 将一个元素处理为可拖动元素
* @example
* ```ts
* const handle = draggable(dom: HTMLElement);
* // 关闭拖动功能
* handle.close();
* // 开启拖动功能
* handle.open();
* // 指定一个子元素，当该鼠标按下该元素时，关闭拖动功能，鼠标抬起后恢复拖动功能
* handle.wrap(dom: HTMLElement);
* ```
* @param dom 要处理的元素
*/
export declare function draggable(dom: HTMLElement): false | {
/**
* 关闭拖动功能
*/
close(): void;
/**
* 开启拖动功能
*/
open(): void;
/**
* 指定一个子元素，当该鼠标按下该元素时，关闭拖动功能，鼠标抬起后恢复拖动功能
* @param dom 要处理的元素
*/
wrap(dom: HTMLElement): void;
};