useIsInitialRender.ts

import { useEffect, useRef } from "react";

/**
 * A React hook that returns true if the component is being rendered for the first time.
 *
 * @returns boolean
 * @example
 * ```tsx
 * import { useIsInitialRender } from "hooks/useIsInitialRender";
 *
 * const Component = () => {
 *   const isInitialRender = useIsInitialRender();
 *
 *   return (
 *     <div>
 *       {isInitialRender ? "This is the first render" : "This is not the first render"}
 *     </div>
 *   );
 * };
 *```
 */
export const useIsInitialRender = () => {
  const initial = useRef(true);

  useEffect(() => {
    initial.current = false;

    return () => {
      initial.current = true;
    };
  }, []);

  return initial.current;
};