Skip to content

Commit

Permalink
feat: improve useEventListener
Browse files Browse the repository at this point in the history
React already handles the change inside refs, therefore there is no need
to unwrap it on each render.
  • Loading branch information
xobotyi committed Jun 30, 2021
1 parent c4fb6bd commit 8c436b3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
3 changes: 2 additions & 1 deletion src/useEventListener/__tests__/dom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ describe('useEventListener', () => {
const addSpy = jest.spyOn(div, 'addEventListener');
const removeSpy = jest.spyOn(div, 'removeEventListener');

const ref = { current: div };
const { rerender, unmount } = renderHook(() =>
useEventListener({ current: div }, 'resize', () => {}, { passive: true })
useEventListener(ref, 'resize', () => {}, { passive: true })
);

expect(addSpy).toHaveBeenCalledTimes(1);
Expand Down
9 changes: 2 additions & 7 deletions src/useEventListener/useEventListener.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { MutableRefObject, RefObject, useEffect, useMemo } from 'react';
import { hasOwnProperty } from '../util/misc';
import { useSyncedRef, useIsMounted } from '..';

type ITargetOrTargetRef<T extends EventTarget> = T | null | RefObject<T> | MutableRefObject<T>;
Expand All @@ -19,11 +18,6 @@ export function useEventListener<T extends EventTarget>(
| Parameters<T['addEventListener']>
| [string, EventListenerOrEventListenerObject | ((...args: any[]) => any), ...any]
): void {
// extract current target from ref object
const tgt: T =
target && hasOwnProperty(target, 'current')
? (target as MutableRefObject<T>).current
: (target as T);
const isMounted = useIsMounted();

// create static event listener
Expand Down Expand Up @@ -53,6 +47,7 @@ export function useEventListener<T extends EventTarget>(
);

useEffect(() => {
const tgt = target && 'current' in target ? target.current : target;
if (!tgt) return undefined;

const restParams = params.slice(2);
Expand All @@ -61,5 +56,5 @@ export function useEventListener<T extends EventTarget>(

return () => tgt.removeEventListener(params[0], eventListener, ...restParams);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [tgt, params[0]]);
}, [target, params[0]]);
}

0 comments on commit 8c436b3

Please sign in to comment.