useMutationObserver

Overview

A hook that provides the ability to watch for changes being made to the DOM tree, refer to MutationObserver

Documentation and Examples

Installation

pnpm dlx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useMutationObserver.json

npx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useMutationObserver.json

yarn shadcn@latest add https://shadcn-ahooks.vercel.app/r/useMutationObserver.json

bun shadcn@latest add https://shadcn-ahooks.vercel.app/r/useMutationObserver.json

A hook that provides the ability to watch for changes being made to the DOM tree, refer to MutationObserver

Examples

Default Usage

API

useMutationObserver(
  callback: MutationCallback,
  target: Target,
  options?: MutationObserverInit,
);

Params

| Property | Description | Type | Default | | -- | ---- | | target | DOM element or ref | () => Element | Element | MutableRefObject<Element> | - | | callback | The callback function | (mutations: MutationRecord[], observer: MutationObserver) => void | - | | options | Setting | MutationObserverInit | - |

Options

For options, please refer to MutationObserver