@jdcfe/yep-react
Version:
一套移动端的React组件库
44 lines (43 loc) • 1.66 kB
TypeScript
/**
* 取消事件绑定
* @param {*} node DOM节点或任何可以绑定事件的对象
* @param {String} eventName 事件名
* @param {Function} callback 回调方法
* @param {Boolean} [useCapture=false] 是否开启事件捕获优先
* or captureObject 类型
*/
declare type captureObject = {
capture: boolean;
passive: boolean;
};
export declare function off(node: any, eventName: string, callback: Function, useCapture: boolean | captureObject): void;
/**
* 绑定事件
* @param {*} node DOM节点或任何可以绑定事件的对象
* @param {String} eventName 事件名
* @param {Function} callback 回调方法
* @param {Boolean} useCapture 是否开启事件捕获优先
* @return {Object} 返回的object中包含一个off方法，用于取消事件监听
*
* @example
* const handler = events.on(document.body, 'click', e => {
* // handle click ...
* });
* // 取消事件绑定
* handler.off();
*/
export declare function on(node: any, eventName: string, callback: Function, useCapture: boolean | captureObject): {
off: () => void;
};
/**
* 绑定事件，只执行一次后销毁
* @param {*} node DOM节点或任何可以绑定事件的对象
* @param {String} eventName 事件名
* @param {Function} callback 回调方法
* @param {Boolean} useCapture 是否开启事件捕获优先
* @return {Function} 返回的object中包含一个off方法，用于取消事件监听
*/
export declare function once(node: any, eventName: string, callback: Function, useCapture: boolean): {
off: () => void;
};
export {};