useDeepCompareEffect

Runs an effect when deep-equal dependencies actually change.

Import

import { useDeepCompareEffect } from '@kamod-ch/hooks'

Live demo

Basic demo

Runs an effect when deep-equal dependencies actually change.

Unrelated count: 0

Effect runs: 0

import { useState } from 'preact/hooks'
import { useDeepCompareEffect } from '@kamod-ch/hooks'

export default function UseDeepCompareEffectDemo() {
  const [count, setCount] = useState(0)
  const [runs, setRuns] = useState(0)
  const config = { page: 1, filters: ['open'] }

  useDeepCompareEffect(() => {
    setRuns((value) => value + 1)
  }, [config])

  return (
    <div>
      <p><strong>Unrelated count:</strong> {count}</p>
      <p><strong>Effect runs:</strong> {runs}</p>
      <button type="button" onClick={() => setCount((value) => value + 1)}>Re-render with deep-equal deps</button>
    </div>
  )
}

API

TypeScript signature

import { useEffect } from 'preact/hooks';
declare const _default: typeof useEffect | typeof import("preact/hooks").useLayoutEffect;
export default _default;
/

SSR considerations

This hook is safe to import during SSR. If your effect body touches the DOM, keep that work inside the effect callback.

Browser compatibility

Works in any modern browser supported by Preact.