useDeepCompareEffect
A hook to use a deep compare effect
Installation
npx shadcn@latest add "https://shadcn-hooks.vercel.app/r/use-deep-compare-effect.json"pnpm dlx shadcn@latest add "https://shadcn-hooks.vercel.app/r/use-deep-compare-effect.json"yarn dlx shadcn@latest add "https://shadcn-hooks.vercel.app/r/use-deep-compare-effect.json"bun x shadcn@latest add "https://shadcn-hooks.vercel.app/r/use-deep-compare-effect.json"Copy and paste the following code into your project.
import { useEffect, useLayoutEffect } from 'react'
import { isBrowser } from '@/registry/lib/is-browser'
/**
* Custom hook that uses either `useLayoutEffect` or `useEffect` based on the environment (client-side or server-side).
* @param {Function} effect - The effect function to be executed.
* @param {Array<any>} [dependencies] - An array of dependencies for the effect (optional).
* @public
* @see [Documentation](https://usehooks-ts.com/react-hook/use-isomorphic-layout-effect)
* @example
* ```tsx
* useIsomorphicLayoutEffect(() => {
* // Code to be executed during the layout phase on the client side
* }, [dependency1, dependency2]);
* ```
*/
export const useIsomorphicLayoutEffect = isBrowser ? useLayoutEffect : useEffectimport { dequal } from 'dequal'
import { useRef } from 'react'
import { useIsomorphicLayoutEffect } from '@/registry/hooks/use-isomorphic-layout-effect'
import type { DependencyList, EffectCallback } from 'react'
export function useDeepCompareEffect(
effect: EffectCallback,
deps: DependencyList,
) {
const ref = useRef<DependencyList>(deps)
if (!ref.current || !dequal(ref.current, deps)) {
ref.current = deps
}
useIsomorphicLayoutEffect(effect, ref.current)
}API
/**
* A hook to use a deep compare effect
* @param effect - The effect to use
* @param deps - The dependencies to use
*/
export function useDeepCompareEffect(
effect: EffectCallback,
deps: DependencyList,
): voidCredits
Last updated on