Skip to content
aq-ui
Back to HooksHook

Use Click Outside

Open-code aq-ui React hook for Use Click Outside.

Installation

pnpm dlx aq-ui@alpha add use-click-outside

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useClickOutside } from "@/hooks/use-click-outside"

useClickOutside

functionSource L14

Open-code aq-ui React hook for Use Click Outside.

function useClickOutside<T extends Element>(targets: Target<T> | Array<Target<T>>, handler: (event: Event) => void, { enabled = true, events = ["pointerdown"], capture = true, }: UseClickOutsideOptions = {}): void
Returns
void

Parameters

NameTypeDefault
targetsTarget<T> | Array<Target<T>>—
handler(event: Event) => void—
options?UseClickOutsideOptions{}

UseClickOutsideOptions

interfaceSource L8

Type contract for UseClickOutsideOptions.

interface UseClickOutsideOptions

Members

NameTypeDefault
enabled?booleantrue
events?Array<"pointerdown" | "mousedown" | "touchstart" | "click">["pointerdown"]
capture?booleantrue

Registry dependencies

hook-target, use-stable-callback

Files

  • hooks/use-click-outside.ts

Source