本文介绍了如何在 CxJS 应用中为 `onWheel` 事件添加主动监听器，以覆盖 React 默认的被动行为。通过 `onRef` 属性获取 DOM 元素，并使用 `addEventListenerWithOptions` 方法，可以创建一个具有 `passive: false` 选项的主动事件监听器，从而允许调用 `preventDefault()` 来阻止默认滚动行为。
React 默认将 onWheel 事件处理程序设置为被动监听器，这意味着你不能在事件处理函数中调用 preventDefault() 来阻止默认的滚动行为。这主要是为了提高滚动性能。然而，在某些情况下，你可能需要阻止默认滚动行为，例如实现自定义滚动逻辑或创建特殊效果。
CxJS 提供了一种方法来解决这个问题，即使用 onRef 属性和 addEventListenerWithOptions 方法。
使用 onRef 获取 DOM 元素
onRef 属性允许你访问组件渲染的底层 DOM 元素。你可以将一个回调函数分配给 onRef，该函数将在元素挂载时被调用，并将元素作为第一个参数传递。
使用 addEventListenerWithOptions 添加主动监听器
CxJS 提供了一个名为 addEventListenerWithOptions 的实用函数，允许你使用指定的选项添加事件监听器。这使你可以创建一个主动 onWheel 事件监听器，该监听器允许你调用 preventDefault()。
示例代码
以下是一个完整的示例，展示了如何在 CxJS 中添加主动 onWheel 事件监听器：
import { addEventListenerWithOptions } from 'cx/util';
import {Widget} from 'cx/ui';
let unsubscribeScroll: () => void;
function addElementListener(el: Element) {
if (unsubscribeScroll) unsubscribeScroll();
if (!el) return;
unsubscribeScroll = addEventListenerWithOptions(
el,
'wheel',
(e: any) => {
e.preventDefault();
// 在此处添加你的自定义滚动逻辑
console.log('Wheel event triggered!');
},
{ passive: false }
);
}
//在组件的render方法中
<div onRef={addElementListener}>
{/* 你的内容 */}
</div>代码解释：
- 导入必要的模块： 从 cx/util 导入 addEventListenerWithOptions 函数。
- 定义 unsubscribeScroll 变量： 这是一个用于存储取消订阅函数的变量。当元素卸载或重新挂载时，我们需要取消之前的监听器，以避免内存泄漏。
-
定义 addElementListener 函数：
- 此函数接受一个 el 参数，即要添加监听器的 DOM 元素。
- 首先，检查 unsubscribeScroll 是否已定义。如果已定义，则调用它来取消之前的监听器。
- 然后，检查 el 是否存在。如果不存在，则直接返回。
- 使用 addEventListenerWithOptions 函数将 wheel 事件监听器添加到 el 元素。
- 第一个参数是元素 el。
- 第二个参数是事件类型 'wheel'。
- 第三个参数是一个回调函数，该函数将在每次触发 wheel 事件时被调用。在此回调函数中，我们首先调用 e.preventDefault() 来阻止默认的滚动行为，然后添加你的自定义滚动逻辑。
- 第四个参数是一个选项对象 { passive: false }，它指定此监听器应为主动监听器。
- 将 addEventListenerWithOptions 返回的取消订阅函数存储在 unsubscribeScroll 变量中。
- 在组件中使用 onRef： 在你的 CxJS 组件中，将 onRef 属性添加到你想要监听 wheel 事件的 div 元素。将 addElementListener 函数分配给 onRef 属性。
注意事项：
- 确保在组件卸载时取消订阅事件监听器，以避免内存泄漏。你可以在 onComponentDidUnmount 生命周期方法中调用 unsubscribeScroll()。
- 过度使用 preventDefault() 可能会影响滚动性能。仅在必要时才使用它。
总结：
通过使用 onRef 属性和 addEventListenerWithOptions 方法，你可以轻松地在 CxJS 应用中添加主动 onWheel 事件监听器，并阻止默认的滚动行为。这使你可以实现自定义滚动逻辑并创建特殊效果。记住在使用 preventDefault() 时要小心，并仅在必要时使用它。
