Hooks

Custom Hooks

Location

All custom hooks go in src/hooks/. Export from src/hooks/index.ts.

Example of available hooks

useWindowSize

Detect window resize and get current dimensions:

import { useWindowSize } from "@/hooks";

export default function MyComponent() {
  const { width, height } = useWindowSize();

  const isMobile = width < 768;
  const isTablet = width >= 768 && width < 1024;
  const isDesktop = width >= 1024;

  return (
    <div>
      {isMobile && <MobileLayout />}
      {isTablet && <TabletLayout />}
      {isDesktop && <DesktopLayout />}
    </div>
  );
}

useBodyScrollLock

Lock body scroll (useful for modals):

import { useBodyScrollLock } from "@/hooks";

export default function Modal({ isOpen, children }) {
  useBodyScrollLock(isOpen);

  if (!isOpen) return null;

  return <div className="modal">{children}</div>;
}

useDebounce

Debounce a value:

import { useState } from "react";
import { useDebounce } from "@/hooks";

export default function SearchInput() {
  const [searchTerm, setSearchTerm] = useState("");
  const debouncedSearch = useDebounce(searchTerm, 500);

  useEffect(() => {
    if (debouncedSearch) {
      // Fetch search results
      fetchResults(debouncedSearch);
    }
  }, [debouncedSearch]);

  return (
    <input
      value={searchTerm}
      => setSearchTerm(e.target.value)}
      placeholder="Search..."
    />
  );
}

useClickOutside

Detect clicks outside an element (useful for dropdowns, modals):

import { useRef } from "react";
import { useClickOutside } from "@/hooks";

export default function Dropdown({ isOpen, onClose, children }) {
  const ref = useRef<HTMLDivElement>(null);

  useClickOutside(ref, () => {
    onClose();
  }, isOpen); // Only active when isOpen is true

  if (!isOpen) return null;

  return (
    <div ref={ref} className="dropdown">
      {children}
    </div>
  );
}

useAnalytics

Track events with dataLayer (GTM):

import { useAnalytics } from "@/hooks";

export default function MyComponent() {
  const { push, trackClick, trackPageView, trackFormSubmit, trackError } = useAnalytics();

  // Track page view
  useEffect(() => {
    trackPageView("Home Page");
  }, [trackPageView]);

  // Track custom event
  const handleCustomEvent = () => {
    push("custom_event", {
      category: "engagement",
      action: "button_click",
      label: "cta_button",
    });
  };

  // Track click
  const handleClick = () => {
    trackClick("buy_button", { product_id: "123" });
  };

  // Track form submit
  const handleSubmit = () => {
    trackFormSubmit("contact_form", { email: "user@example.com" });
  };

  // Track error
  const handleError = () => {
    trackError("Payment failed", "PAYMENT_001");
  };

  return (
    <button
      Buy Now
    </button>
  );
}

Creating New Hooks

Follow this pattern:

// src/hooks/useMyHook.ts
import { useState, useEffect } from "react";

interface UseMyHookReturn {
  value: string;
  setValue: (value: string) => void;
}

export function useMyHook(initialValue: string): UseMyHookReturn {
  const [value, setValue] = useState(initialValue);

  useEffect(() => {
    // Side effect logic
  }, [value]);

  return { value, setValue };
}

Then export from src/hooks/index.ts:

export { useMyHook } from "./useMyHook";

Import with:

import { useMyHook } from "@/hooks";

Important Notes

• Prefix with use - All hooks must start with use
• Export from index.ts - Import from @/hooks
• Handle SSR - Check for typeof window !== "undefined" before accessing browser APIs
• Avoid any type - Define proper return types
• Clean up effects - Always return cleanup functions from useEffect
• useAnalytics does NOT load GTM - Only exposes dataLayer.push. GTM must be loaded separately (via react-gtm-module in _app.tsx)

Converted and distributed by TomeVault — claim your Tome and manage your conversions.