Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: improve useEventListener #169

Merged
merged 1 commit into from
Jul 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
16 changes: 5 additions & 11 deletions src/useEventListener/useEventListener.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { MutableRefObject, RefObject, useEffect, useMemo } from 'react';
import { RefObject, useEffect, useMemo } from 'react';
import { useIsMounted, useSyncedRef } from '..';
import { hasOwnProperty } from '../util/misc';
import { useSyncedRef, useIsMounted } from '..';

type ITargetOrTargetRef<T extends EventTarget> = T | null | RefObject<T> | MutableRefObject<T>;

/**
* Subscribes an event listener to the target, and automatically unsubscribes
Expand All @@ -14,16 +12,11 @@ type ITargetOrTargetRef<T extends EventTarget> = T | null | RefObject<T> | Mutab
* it is `[eventName, listener, options]`.
*/
export function useEventListener<T extends EventTarget>(
target: ITargetOrTargetRef<T>,
target: RefObject<T> | T | null,
...params:
| 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 +46,7 @@ export function useEventListener<T extends EventTarget>(
);

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

const restParams = params.slice(2);
Expand All @@ -61,5 +55,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]]);
}