useClickOutside

v0.0.14testeddemo

Invokes `handler` when a pointer event occurs outside `target`. SSR-safe: no-op on the server. Handles portaled/ignored subtrees and guards against synthetic "outside" clicks on removed nodes.

Source Tests

Demo

Loading demo…

Signature

export function useClickOutside(
  target: MaybeComputedElementRef,
  handler: (event: PointerEvent | MouseEvent) => void,
  options: UseClickOutsideOptions ={ ... }

Parameters

Parameter	Type	Default	Description
`target`	`MaybeComputedElementRef`	—	Element to watch. Events inside it are ignored.
`handler`	`(event: PointerEvent \| MouseEvent) => void`	—	Callback invoked with the outside event
`options`?	`UseClickOutsideOptions`	`{}`	Options

Returns

VoidFunctionStop handle to remove the listeners