useDocumentEvent

Hook attaches an event listener to the document object for the specified event

browser

low

test coverage

Last changed: 4 months ago

Installation

Library

CLI

Manual

import { useDocumentEvent } from '@siberiacancode/reactuse';

Usage

useDocumentEvent('click', () => console.log('clicked'));

## Demo

source

Api

Parameters

Name	Type	Default	Note
event	Event	-	The event to listen for.
listener	(event: DocumentEventMap[Event]) => void	-	The callback function to be executed when the event is triggered
options?	UseEventListenerOptions	-	The options for the event listener

Returns

void

Type declaration

import type { UseEventListenerOptions } from '../useEventListener/useEventListener';

Source

Source • Demo

Contributors

D

debabin

H

hywax