UNPKG

1.54 kBPlain TextView Raw
1/*
2 * Copyright 2021 Adobe. All rights reserved.
3 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License. You may obtain a copy
5 * of the License at http://www.apache.org/licenses/LICENSE-2.0
6 *
7 * Unless required by applicable law or agreed to in writing, software distributed under
8 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
9 * OF ANY KIND, either express or implied. See the License for the specific language
10 * governing permissions and limitations under the License.
11 */
12
13import {RefObject, useCallback} from 'react';
14import {ScrollEvents} from '@react-types/shared';
15import {useEvent} from '@react-aria/utils';
16
17export interface ScrollWheelProps extends ScrollEvents {
18 /** Whether the scroll listener should be disabled. */
19 isDisabled?: boolean
20}
21
22// scroll wheel needs to be added not passively so it's cancelable, small helper hook to remember that
23export function useScrollWheel(props: ScrollWheelProps, ref: RefObject<HTMLElement>): void {
24 let {onScroll, isDisabled} = props;
25 let onScrollHandler = useCallback((e) => {
26 // If the ctrlKey is pressed, this is a zoom event, do nothing.
27 if (e.ctrlKey) {
28 return;
29 }
30
31 // stop scrolling the page
32 e.preventDefault();
33 e.stopPropagation();
34
35 if (onScroll) {
36 onScroll({deltaX: e.deltaX, deltaY: e.deltaY});
37 }
38 }, [onScroll]);
39
40 useEvent(ref, 'wheel', isDisabled ? undefined : onScrollHandler);
41}