t-comm/lib/wheel/wheel.d.ts

专业、稳定、纯粹的工具库

/**
 * 使用鼠标滚轮控制元素的scrollLeft实现左右移动
 * @param {HTMLElement} element - 需要控制移动的DOM元素
 * @param {Object} [options] - 配置选项
 * @param {number} [options.speed=50] - 移动速度（像素/滚动单位）
 * @param {boolean} [options.preventDefault=true] - 是否阻止默认滚动行为
 * @param {boolean} [options.invertDirection=false] - 是否反转滚动方向
 * @example
 * ```ts
 * // 基础用法：让横向滚动容器支持鼠标滚轮横向滚动
 * const el = document.querySelector('.scroll-container') as HTMLElement;
 * const dispose = enableHorizontalScroll(el);
 *
 * // 自定义速度和方向
 * enableHorizontalScroll(el, {
 *   speed: 100,
 *   invertDirection: true,
 * });
 *
 * // 不阻止默认滚动行为（页面仍可垂直滚动）
 * enableHorizontalScroll(el, { preventDefault: false });
 *
 * // 组件销毁时取消监听
 * dispose?.();
 * ```
 */
export declare function enableHorizontalScroll(element: HTMLElement, options?: {}): (() => void) | undefined;