Skip to content
aq-ui
Back to HooksHook

Use Mutation Observer

Open-code aq-ui React hook for Use Mutation Observer.

Installation

pnpm dlx aq-ui@alpha add use-mutation-observer

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 { useMutationObserver } from "@/hooks/use-mutation-observer"

MutationObserverResult

interfaceSource L17

Type contract for MutationObserverResult.

interface MutationObserverResult

Members

NameType
recordsMutationRecord[]
supportedboolean

useMutationObserver

functionSource L22

Open-code aq-ui React hook for Use Mutation Observer.

function useMutationObserver<T extends Node>(target: Target<T>, observerOptions: MutationObserverInit, { enabled = true, onMutate }: UseMutationObserverOptions = {}): MutationObserverResult
Returns
MutationObserverResult

Parameters

NameTypeDefault
targetTarget<T>—
observerOptionsMutationObserverInit—
options?UseMutationObserverOptions{}

UseMutationObserverOptions

interfaceSource L12

Type contract for UseMutationObserverOptions.

interface UseMutationObserverOptions

Members

NameTypeDefault
enabled?booleantrue
onMutate?(records: MutationRecord[]) => void—

Registry dependencies

hook-observer-pools, hook-target, use-stable-callback

Files

  • hooks/use-mutation-observer.ts

Source