useIsomorphicLayoutEffect

Custom hook that uses either useLayoutEffect or useEffect based on the environment (client-side or server-side).

Usage

import { useIsomorphicLayoutEffect } from 'vhooks'

export default function Component() {
  useIsomorphicLayoutEffect(() => {
    console.log(
      "In the browser, I'm an `useLayoutEffect`, but in SSR, I'm an `useEffect`.",
    )
  }, [])

  return <p>Hello, world</p>
}

Installation

pnpm

pnpm dlx scaflo@latest https://raw.githubusercontent.com/programming-with-ia/vDocs/scaflos/hooks/useIsomorphicLayoutEffect.json -e %src%/hooks

npm

npx scaflo@latest https://raw.githubusercontent.com/programming-with-ia/vDocs/scaflos/hooks/useIsomorphicLayoutEffect.json -e %src%/hooks

bun

bunx scaflo@latest https://raw.githubusercontent.com/programming-with-ia/vDocs/scaflos/hooks/useIsomorphicLayoutEffect.json -e %src%/hooks

yarn

yarn dlx scaflo@latest https://raw.githubusercontent.com/programming-with-ia/vDocs/scaflos/hooks/useIsomorphicLayoutEffect.json -e %src%/hooks

API

▸ useIsomorphicLayoutEffect(effect, deps?): void

Custom hook that uses either useLayoutEffect or useEffect based on the environment (client-side or server-side).

Parameters

Name	Type	Description
effect	EffectCallback	The effect function to be executed.
deps?	DependencyList	-

Returns

void

Hook

import { useEffect, useLayoutEffect } from 'react'

export const useIsomorphicLayoutEffect =
  typeof window !== 'undefined' ? useLayoutEffect : useEffect