shadcn-ahooks

useFocusWithin

Monitor whether the current focus is within a certain area, Same as css attribute

Overview

Monitor whether the current focus is within a certain area, Same as css attribute :focus-within.

Documentation and Examples

Installation

Open in
pnpm dlx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useFocusWithin.json
npx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useFocusWithin.json
yarn shadcn@latest add https://shadcn-ahooks.vercel.app/r/useFocusWithin.json
bun shadcn@latest add https://shadcn-ahooks.vercel.app/r/useFocusWithin.json

Examples

Default usage

Pass in DOM element

API

const isFocusWithin = useFocusWithin(
  target,
  {
   onFocus,
   onBlur,
   onChange
  }
);

Params

PropertyDescriptionTypeDefault
targetDOM element or ref() => Element | Element | MutableRefObject<Element>-
optionsMore configOptions-

Options

PropertyDescriptionTypeDefault
onFocusCallback to be executed on focus(e: FocusEvent) => void-
onBlurCallback to be executed on blur(e: FocusEvent) => void-
onChangeCallback to be executed on focus change(isFocusWithin: boolean) => void-

Result

PropertyDescriptionType
isFocusWithinWhether the focus is in the current areaboolean

On this page