Skip to content

引入

ts
import { enableHorizontalScroll } from 't-comm';

// 不支持 tree-shaking 的项目
import { enableHorizontalScroll} from 't-comm/lib/wheel/index';

// 只支持 ESM 的项目
import { enableHorizontalScroll} from 't-comm/es/wheel/index';

enableHorizontalScroll(element, [options])

描述:使用鼠标滚轮控制元素的scrollLeft实现左右移动

参数

参数名类型默认值描述
elementHTMLElement需要控制移动的DOM元素
[options]Object配置选项
[options.speed]number50移动速度(像素/滚动单位)
[options.preventDefault]booleantrue是否阻止默认滚动行为
[options.invertDirection]booleanfalse是否反转滚动方向

示例

ts
// 基础用法:让横向滚动容器支持鼠标滚轮横向滚动
const el = document.querySelector('.scroll-container') as HTMLElement;
const dispose = enableHorizontalScroll(el);

// 自定义速度和方向
enableHorizontalScroll(el, {
  speed: 100,
  invertDirection: true,
});

// 不阻止默认滚动行为(页面仍可垂直滚动)
enableHorizontalScroll(el, { preventDefault: false });

// 组件销毁时取消监听
dispose?.();