引入
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实现左右移动
参数:
| 参数名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| element | HTMLElement | 需要控制移动的DOM元素 | |
| [options] | Object | 配置选项 | |
| [options.speed] | number | 50 | 移动速度(像素/滚动单位) |
| [options.preventDefault] | boolean | true | 是否阻止默认滚动行为 |
| [options.invertDirection] | boolean | false | 是否反转滚动方向 |
示例
ts
// 基础用法:让横向滚动容器支持鼠标滚轮横向滚动
const el = document.querySelector('.scroll-container') as HTMLElement;
const dispose = enableHorizontalScroll(el);
// 自定义速度和方向
enableHorizontalScroll(el, {
speed: 100,
invertDirection: true,
});
// 不阻止默认滚动行为(页面仍可垂直滚动)
enableHorizontalScroll(el, { preventDefault: false });
// 组件销毁时取消监听
dispose?.();