React Hook Patterns: Mastering Custom Hook Development for Global Applications

            
import React, { useState, useCallback } from 'react';

/**
 * A custom hook to manage a numerical counter.
 * @param {number} initialValue - The initial value of the counter. Defaults to 0.
 * @returns {{ count: number, increment: () => void, decrement: () => void, reset: () => void }}
 */
function useCounter(initialValue = 0) {
  const [count, setCount] = useState(initialValue);

  const increment = useCallback(() => {
    setCount(prevCount => prevCount + 1);
  }, []); // No dependencies, as setCount is stable

  const decrement = useCallback(() => {
    setCount(prevCount => prevCount - 1);
  }, []); // No dependencies

  const reset = useCallback(() => {
    setCount(initialValue);
  }, [initialValue]); // Depends on initialValue

  return {
    count,
    increment,
    decrement,
    reset
  };
}

export default useCounter;

            

              
                Copy
              
            
          

            
import React from 'react';
import useCounter from './useCounter'; // Assuming useCounter.js is in the same directory

function CounterComponent() {
  const { count, increment, decrement, reset } = useCounter(10);

  return (
    <div>
      <h3>Current Count: {count}</h3>
      <button onClick={increment}>Increment</button>
      <button onClick={decrement}>Decrement</button>
      <button onClick={reset}>Reset</button>
    </div>
  );
}

export default CounterComponent;

            

              
                Copy
              
            
          

            
import React, { useState, useEffect, useCallback } from 'react';

/**
 * A custom hook for fetching data from an API.
 * @param {string} url - The URL to fetch data from.
 * @param {object} options - Fetch options (e.g., headers, method, body).
 * @returns {{ data: any, loading: boolean, error: Error | null, refetch: () => void }}
 */
function useFetch(url, options = {}) {
  const [data, setData] = useState(null);
  const [loading, setLoading] = useState(true);
  const [error, setError] = useState(null);

  const fetchData = useCallback(async () => {
    setLoading(true);
    setError(null);
    try {
      const response = await fetch(url, options);
      if (!response.ok) {
        throw new Error(`HTTP error! status: ${response.status}`);
      }
      const result = await response.json();
      setData(result);
    } catch (err) {
      setError(err);
    } finally {
      setLoading(false);
    }
  }, [url, JSON.stringify(options)]); // Stringify options for deep comparison

  useEffect(() => {
    fetchData();
  }, [fetchData]);

  return { data, loading, error, refetch: fetchData };
}

export default useFetch;

            

              
                Copy
              
            
          

            
import React from 'react';
import useFetch from './useFetch';

function UserProfile({ userId }) {
  const { data: user, loading, error } = useFetch(`https://api.example.com/users/${userId}`);

  if (loading) return <p>Loading user profile...</p>;
  if (error) return <p style={{ color: 'red' }}>Error: {error.message}</p>;
  if (!user) return <p>No user data found.</p>;

  return (
    <div>
      <h2>{user.name}</h2>
      <p>Email: {user.email}</p>
      <p>Location: {user.location}</p>
      <!-- More user details -->
    </div>
  );
}

export default UserProfile;

            

              
                Copy
              
            
          

            
import React, { useState, useEffect } from 'react';

/**
 * A custom hook to persist state in localStorage.
 * @param {string} key - The key for localStorage.
 * @param {any} initialValue - The initial value if no data is found in localStorage.
 * @returns {[any, (value: any) => void]}
 */
function useLocalStorage(key, initialValue) {
  // State to store our value
  // Pass initial state function to useState so logic is only executed once
  const [storedValue, setStoredValue] = useState(() => {
    try {
      const item = typeof window !== 'undefined' ? window.localStorage.getItem(key) : null;
      return item ? JSON.parse(item) : initialValue;
    } catch (error) {
      console.error(`Error reading localStorage key "${key}":`, error);
      return initialValue;
    }
  });

  // useEffect to update localStorage when the state changes
  useEffect(() => {
    try {
      if (typeof window !== 'undefined') {
        window.localStorage.setItem(key, JSON.stringify(storedValue));
      }
    } catch (error) {
      console.error(`Error writing to localStorage key "${key}":`, error);
    }
  }, [key, storedValue]);

  return [storedValue, setStoredValue];
}

export default useLocalStorage;

            

              
                Copy
              
            
          

            
import React from 'react';
import useLocalStorage from './useLocalStorage';

function ThemeSwitcher() {
  const [isDarkMode, setIsDarkMode] = useLocalStorage('theme-preference', false);

  const toggleTheme = () => {
    setIsDarkMode(prevMode => !prevMode);
    document.body.className = isDarkMode ? '' : 'dark-theme'; // Apply CSS class
  };

  return (
    <div>
      <p>Current Theme: {isDarkMode ? '<strong>Dark</strong>' : '<strong>Light</strong>'}</p>
      <button onClick={toggleTheme}>
        Switch to {isDarkMode ? 'Light' : 'Dark'} Theme
      </button>
    </div>
  );
}

export default ThemeSwitcher;

            

              
                Copy
              
            
          

            
import { useState, useCallback } from 'react';

/**
 * A custom hook to manage a boolean state.
 * @param {boolean} initialValue - The initial boolean value. Defaults to false.
 * @returns {[boolean, () => void, (value: boolean) => void]}
 */
function useToggle(initialValue = false) {
  const [value, setValue] = useState(initialValue);

  const toggle = useCallback(() => {
    setValue(prev => !prev);
  }, []);

  return [value, toggle, setValue];
}

export default useToggle;

            

              
                Copy
              
            
          

            
import React from 'react';
import useToggle from './useToggle';

function ModalComponent() {
  const [isOpen, toggleOpen] = useToggle(false);

  return (
    <div>
      <button onClick={toggleOpen}>Toggle Modal</button>
      {isOpen && (
        <div style={{
          border: '1px solid black', 
          padding: '20px', 
          margin: '10px', 
          backgroundColor: 'lightblue'
        }}>
          <h3>This is a Modal</h3>
          <p>Content goes here.</p>
          <button onClick={toggleOpen}>Close Modal</button>
        </div>
      )}
    </div>
  );
}

export default ModalComponent;

            

              
                Copy
              
            
          

            
import { useEffect, useRef } from 'react';

/**
 * A custom hook to attach and clean up event listeners.
 * @param {string} eventName - The name of the event (e.g., 'click', 'resize').
 * @param {function} handler - The event handler function.
 * @param {EventTarget} element - The DOM element to attach the listener to. Defaults to window.
 * @param {object} options - Event listener options (e.g., { capture: true }).
 */
function useEventListener(eventName, handler, element = window, options = {}) {
  // Create a ref that stores handler
  const savedHandler = useRef();

  // Update ref.current value if handler changes. This allows the effect below to
  // always use the latest handler without needing to re-attach the event listener.
  useEffect(() => {
    savedHandler.current = handler;
  }, [handler]);

  useEffect(() => {
    // Ensure the element supports addEventListener
    const isSupported = element && element.addEventListener;
    if (!isSupported) return;

    // Create event listener that calls savedHandler.current
    const eventListener = event => savedHandler.current(event);

    // Add event listener
    element.addEventListener(eventName, eventListener, options);

    // Clean up on unmount or when dependencies change
    return () => {
      element.removeEventListener(eventName, eventListener, options);
    };
  }, [eventName, element, options]); // Re-run if eventName or element changes
}

export default useEventListener;

            

              
                Copy
              
            
          

            
import React, { useState } from 'react';
import useEventListener from './useEventListener';

function KeyPressDetector() {
  const [key, setKey] = useState('None');

  const handleKeyPress = (event) => {
    setKey(event.key);
  };

  useEventListener('keydown', handleKeyPress);

  return (
    <div>
      <p>Press any key to see its name:</p>
      <strong>Last Key Pressed: {key}</strong>
    </div>
  );
}

export default KeyPressDetector;

            

              
                Copy
              
            
          

            
import { useState, useCallback } from 'react';

/**
 * A custom hook for managing form state and handling input changes.
 * @param {object} initialValues - An object with initial form field values.
 * @param {object} validationRules - An object with validation functions for each field.
 * @returns {{ values: object, errors: object, handleChange: (e: React.ChangeEvent) => void, handleSubmit: (callback: (values: object) => void) => (e: React.FormEvent) => void, resetForm: () => void }}
 */
function useForm(initialValues, validationRules = {}) {
  const [values, setValues] = useState(initialValues);
  const [errors, setErrors] = useState({});

  const handleChange = useCallback((event) => {
    event.persist(); // Persist the event to use it asynchronously (if needed)
    const { name, value, type, checked } = event.target;

    setValues((prevValues) => ({
      ...prevValues,
      [name]: type === 'checkbox' ? checked : value,
    }));

    // Clear error for the field as soon as it's changed
    if (errors[name]) {
      setErrors((prevErrors) => {
        const newErrors = { ...prevErrors };
        delete newErrors[name];
        return newErrors;
      });
    }
  }, [errors]);

  const validate = useCallback(() => {
    const newErrors = {};
    for (const fieldName in validationRules) {
      if (validationRules.hasOwnProperty(fieldName)) {
        const rule = validationRules[fieldName];
        const value = values[fieldName];
        if (rule && !rule(value)) {
          newErrors[fieldName] = `Invalid ${fieldName}`;
          // In a real app, you'd provide specific error messages based on the rule
        }
      }
    }
    setErrors(newErrors);
    return Object.keys(newErrors).length === 0;
  }, [values, validationRules]);

  const handleSubmit = useCallback((callback) => (event) => {
    event.preventDefault();
    const isValid = validate();
    if (isValid) {
      callback(values);
    }
  }, [values, validate]);

  const resetForm = useCallback(() => {
    setValues(initialValues);
    setErrors({});
  }, [initialValues]);

  return {
    values,
    errors,
    handleChange,
    handleSubmit,
    resetForm,
  };
}

export default useForm;

            

              
                Copy
              
            
          

            
import React from 'react';
import useForm from './useForm';

const emailRegex = /^[\w-.]+@([\w-]+\.)+[\w-]{2,4}$/;

function LoginForm() {
  const { values, errors, handleChange, handleSubmit } = useForm(
    { email: '', password: '' },
    {
      email: (value) => emailRegex.test(value) && value.length > 0,
      password: (value) => value.length >= 6,
    }
  );

  const submitLogin = (formData) => {
    alert(`Submitting: Email: ${formData.email}, Password: ${formData.password}`);
    // In a real app, send data to an API
  };

  return (
    <form onSubmit={handleSubmit(submitLogin)}>
      <h2>Login</h2>
      <div>
        <label htmlFor="email">Email:</label>
        <input
          type="email"
          id="email"
          name="email"
          value={values.email}
          onChange={handleChange}
        />
        {errors.email && <p style={{ color: 'red' }}>{errors.email}</p>}
      </div>
      <div>
        <label htmlFor="password">Password:</label>
        <input
          type="password"
          id="password"
          name="password"
          value={values.password}
          onChange={handleChange}
        />
        {errors.password && <p style={{ color: 'red' }}>{errors.password}</p>}
      </div>
      <button type="submit">Login</button>
    </form>
  );
}

export default LoginForm;

            

              
                Copy
              
            
          

            
// AuthContext.js
import React, { createContext, useContext, useState, useEffect, useCallback } from 'react';

const AuthContext = createContext(null);

// Custom Hook for Authentication Logic
export function useAuth() {
  const [user, setUser] = useState(null);
  const [isLoading, setIsLoading] = useState(true);

  // Simulate an async login function
  const login = useCallback(async (username, password) => {
    setIsLoading(true);
    return new Promise(resolve => {
      setTimeout(() => {
        if (username === 'test' && password === 'password') {
          const userData = { id: '123', name: 'Global User' };
          setUser(userData);
          localStorage.setItem('user', JSON.stringify(userData));
          resolve(true);
        } else {
          resolve(false);
        }
        setIsLoading(false);
      }, 1000);
    });
  }, []);

  // Simulate an async logout function
  const logout = useCallback(() => {
    setUser(null);
    localStorage.removeItem('user');
  }, []);

  // Load user from localStorage on mount
  useEffect(() => {
    const storedUser = localStorage.getItem('user');
    if (storedUser) {
      try {
        setUser(JSON.parse(storedUser));
      } catch (e) {
        console.error('Failed to parse user from localStorage', e);
        localStorage.removeItem('user');
      }
    }
    setIsLoading(false);
  }, []);

  return { user, isLoading, login, logout };
}

// AuthProvider component to wrap your application or parts of it
export function AuthProvider({ children }) {
  const auth = useAuth(); // This is where our custom hook is used

  return (
    <AuthContext.Provider value={auth}>
      {children}
    </AuthContext.Provider>
  );
}

// Custom Hook to consume the AuthContext
export function useAuthContext() {
  const context = useContext(AuthContext);
  if (context === undefined) {
    throw new Error('useAuthContext must be used within an AuthProvider');
  }
  return context;
}

            

              
                Copy
              
            
          

            
// App.js (or root component)
import React from 'react';
import { AuthProvider, useAuthContext } from './AuthContext';

function Dashboard() {
  const { user, isLoading, logout } = useAuthContext();

  if (isLoading) return <p>Loading authentication status...</p>;
  if (!user) return <p>Please log in.</p>;

  return (
    <div>
      <h2>Welcome, {user.name}!</h2>
      <button onClick={logout}>Logout</button>
    </div>
  );
}

function LoginFormForContext() {
  const { login } = useAuthContext();
  const [username, setUsername] = useState('');
  const [password, setPassword] = useState('');

  const handleLogin = async (e) => {
    e.preventDefault();
    const success = await login(username, password);
    if (!success) {
      alert('Login failed!');
    }
  };

  return (
    <form onSubmit={handleLogin}>
      <input type="text" placeholder="Username" value={username} onChange={e => setUsername(e.target.value)} />
      <input type="password" placeholder="Password" value={password} onChange={e => setPassword(e.target.value)} />
      <button type="submit">Login</button>
    </form>
  );
}

function App() {
  return (
    <AuthProvider>
      <h1>Auth Example with Custom Hook & Context</h1>
      <LoginFormForContext />
      <Dashboard />
    </AuthProvider>
  );
}

export default App;

            

              
                Copy
              
            
          

            
// Example of AbortController in useFetch (simplified for clarity)
import React, { useState, useEffect } from 'react';

function useFetchAbortable(url) {
  const [data, setData] = useState(null);
  const [error, setError] = useState(null);
  const [loading, setLoading] = useState(true);

  useEffect(() => {
    const abortController = new AbortController();
    const signal = abortController.signal;

    setLoading(true);
    setError(null);

    fetch(url, { signal })
      .then(response => {
        if (!response.ok) throw new Error(response.statusText);
        return response.json();
      })
      .then(setData)
      .catch(err => {
        if (err.name === 'AbortError') {
          console.log('Fetch aborted');
        } else {
          setError(err);
        }
      })
      .finally(() => setLoading(false));

    return () => {
      // Abort fetch request if component unmounts or dependencies change
      abortController.abort();
    };
  }, [url]);

  return { data, error, loading };
}

export default useFetchAbortable;

            

              
                Copy
              
            
          

            
// Example test for useCounter (conceptual)
import { renderHook, act } from '@testing-library/react-hooks';
import useCounter from './useCounter';

describe('useCounter', () => {
  it('should increment the count', () => {
    const { result } = renderHook(() => useCounter(0));

    act(() => {
      result.current.increment();
    });

    expect(result.current.count).toBe(1);
  });

  it('should reset the count to initial value', () => {
    const { result } = renderHook(() => useCounter(5));

    act(() => {
      result.current.increment();
    });
    expect(result.current.count).toBe(6);

    act(() => {
      result.current.reset();
    });
    expect(result.current.count).toBe(5);
  });

  // More tests for decrement, initial value, etc.
});

            

              
                Copy
              
            
          

            
// Conceptual useLocalizedDate hook
import { useState, useEffect } from 'react';

function useLocalizedDate(dateString, locale = 'en-US', options = {}) {
  const [formattedDate, setFormattedDate] = useState('');

  useEffect(() => {
    try {
      const date = new Date(dateString);
      setFormattedDate(date.toLocaleDateString(locale, options));
    } catch (e) {
      console.error('Invalid date string provided to useLocalizedDate:', dateString, e);
      setFormattedDate('Invalid Date');
    }
  }, [dateString, locale, JSON.stringify(options)]);

  return formattedDate;
}

// Usage:
// const myDate = useLocalizedDate('2023-10-26T10:00:00Z', 'de-DE', { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' });
// // myDate would be 'Donnerstag, 26. Oktober 2023'

            

              
                Copy
              
            
          

            
import { useState, useEffect } from 'react';

/**
 * A custom hook to debounce a value.
 * @param {any} value - The value to debounce.
 * @param {number} delay - The delay in milliseconds.
 * @returns {any} The debounced value.
 */
function useDebounce(value, delay) {
  const [debouncedValue, setDebouncedValue] = useState(value);

  useEffect(() => {
    const handler = setTimeout(() => {
      setDebouncedValue(value);
    }, delay);

    return () => {
      clearTimeout(handler);
    };
  }, [value, delay]);

  return debouncedValue;
}

export default useDebounce;

            

              
                Copy
              
            
          

            
import React, { useState } from 'react';
import useDebounce from './useDebounce';

function SearchInput() {
  const [searchTerm, setSearchTerm] = useState('');
  const debouncedSearchTerm = useDebounce(searchTerm, 500); // 500ms delay

  // Effect for fetching search results based on debouncedSearchTerm
  useEffect(() => {
    if (debouncedSearchTerm) {
      console.log(`Fetching results for: ${debouncedSearchTerm}`);
      // Make API call here
    } else {
      console.log('Search term cleared.');
    }
  }, [debouncedSearchTerm]);

  return (
    <div>
      <input
        type="text"
        placeholder="Search..."
        value={searchTerm}
        onChange={(e) => setSearchTerm(e.target.value)}
      />
      <p>Searching for: <strong>{debouncedSearchTerm || '...'}</strong></p>
    </div>
  );
}

export default SearchInput;

            

              
                Copy