@geee-be/react-utils

A collection of powerful, type-safe React hooks and utility functions designed to enhance modern React applications. Built with TypeScript, SSR compatibility, and performance in mind.

✨ Features

🪝 Custom React Hooks - Enhanced state management and utility hooks
🔒 Type Safe - Full TypeScript support with comprehensive type definitions
🌐 SSR Compatible - Works seamlessly with Next.js and other SSR frameworks
⚡ Performance Focused - Optimized for minimal re-renders and memory usage
🧩 Modular - Tree-shakeable exports for optimal bundle size
🔧 Browser API Wrappers - Safe abstractions for modern browser features
📱 Device Detection - Responsive utilities for different environments
🔄 State Persistence - Local storage integration with sync capabilities

📋 Installation

npm install @geee-be/react-utils
# or
pnpm add @geee-be/react-utils
# or
yarn add @geee-be/react-utils

Peer Dependencies

npm install react react-dom

Required versions:

React >= 18.0.0

🚀 Quick Start

import { useLocalState, useIsClient, useIsMobile } from '@geee-be/react-utils';

function MyComponent() {
  const [theme, setTheme] = useLocalState('theme', 'light');
  const isClient = useIsClient();
  const isMobile = useIsMobile();

  if (!isClient) {
    return <div>Loading...</div>;
  }

  return (
    <div className={`theme-${theme} ${isMobile ? 'mobile' : 'desktop'}`}>
      <button onClick={() => setTheme(theme === 'light' ? 'dark' : 'light')}>
        Toggle Theme
      </button>
    </div>
  );
}

🪝 Hooks Overview

State Management

`useLocalState`

Enhanced useState with localStorage persistence and cross-tab synchronization.

import { useLocalState } from '@geee-be/react-utils';

function Settings() {
  const [settings, setSettings] = useLocalState('user-settings', {
    theme: 'light',
    language: 'en'
  });

  return (
    <div>
      <button onClick={() => setSettings(prev => ({ ...prev, theme: 'dark' }))}>
        Enable Dark Mode
      </button>
    </div>
  );
}

Features:

Automatic localStorage synchronization
Cross-tab state updates
SSR-safe initialization
Type-safe with TypeScript inference

`useHistoryState`

State management with browser history integration for navigation state persistence.

import { useHistoryState } from '@geee-be/react-utils';

function SearchPage() {
  const [query, setQuery] = useHistoryState('search', '');

  return (
    <input
      value={query}
      onChange={(e) => setQuery(e.target.value)}
      placeholder="Search..."
    />
  );
}

Environment Detection

`useIsClient`

Detect client-side rendering vs server-side rendering to prevent hydration mismatches.

import { useIsClient } from '@geee-be/react-utils';

function ClientOnlyFeature() {
  const isClient = useIsClient();

  if (!isClient) {
    return <div>Loading...</div>; // Server-side fallback
  }

  return <ExpensiveClientComponent />;
}

`useIsMobile`

Responsive device detection with customizable breakpoints.

import { useIsMobile } from '@geee-be/react-utils';

function ResponsiveNav() {
  const isMobile = useIsMobile(768); // Custom breakpoint

  return isMobile ? <MobileNav /> : <DesktopNav />;
}

Communication

`useBroadcastChannel`

Cross-tab/window communication using the Broadcast Channel API with fallback.

import { useBroadcastChannel } from '@geee-be/react-utils';

function ChatApp() {
  const [message, postMessage] = useBroadcastChannel('chat-channel');

  useEffect(() => {
    if (message) {
      console.log('Received message:', message);
      // Handle incoming message from other tabs
    }
  }, [message]);

  const sendMessage = () => {
    postMessage({ text: 'Hello from another tab!', timestamp: Date.now() });
  };

  return <button onClick={sendMessage}>Send Message</button>;
}

🛠️ Utility Functions

Component Helpers

`ClientOnly`

Wrapper component for client-side only rendering.

import { ClientOnly } from '@geee-be/react-utils';

function App() {
  return (
    <div>
      <h1>Server and Client Rendered</h1>
      <ClientOnly>
        <ExpensiveClientComponent />
      </ClientOnly>
    </div>
  );
}

`withSubComponents`

Utility for creating compound components with sub-components.

import { withSubComponents } from '@geee-be/react-utils';

// Create compound components easily
const Card = withSubComponents(CardRoot, {
  Header: CardHeader,
  Content: CardContent,
  Footer: CardFooter
});

// Usage
<Card>
  <Card.Header>Title</Card.Header>
  <Card.Content>Content here</Card.Content>
</Card>

`Monitor`

Development component for monitoring component renders and lifecycle.

import { Monitor } from '@geee-be/react-utils';

function DebugComponent() {
  return (
    <Monitor label="MyComponent">
      <MyComponent />
    </Monitor>
  );
}
// Logs: "MyComponent mounted", "MyComponent rendered 1", etc.

Effects and Interactions

`createRipple`

Material Design ripple effect implementation for click interactions.

import { createRipple } from '@geee-be/react-utils';

function RippleButton() {
  return (
    <button
      onClick={createRipple}
      className="relative overflow-hidden"
    >
      Click for Ripple Effect
    </button>
  );
}

// Or use with custom event handler
function CustomButton() {
  const handleClick = (event) => {
    createRipple(event);
    // Your custom logic here
  };

  return (
    <button
      onClick={handleClick}
      className="relative overflow-hidden"
    >
      Custom Click Handler
    </button>
  );
}

NOTE: it is important that the button has className="relative"

🌐 SSR Compatibility

All hooks and utilities are designed to work seamlessly with server-side rendering:

Next.js Integration

// pages/_app.tsx or app/layout.tsx
import { useIsClient } from '@geee-be/react-utils';

function MyApp({ Component, pageProps }) {
  const isClient = useIsClient();

  return (
    <div>
      <Component {...pageProps} />
      {isClient && <ClientOnlyAnalytics />}
    </div>
  );
}

Hydration Safety

import { useLocalState, useIsClient } from '@geee-be/react-utils';

function ThemeProvider({ children }) {
  const [theme, setTheme] = useLocalState('theme', 'light');
  const isClient = useIsClient();

  // Prevents hydration mismatch
  const currentTheme = isClient ? theme : 'light';

  return (
    <div data-theme={currentTheme}>
      {children}
    </div>
  );
}

🎯 Performance Considerations

Optimized Re-renders

Hooks use React's built-in optimization patterns:

// useLocalState only re-renders when the actual value changes
const [count, setCount] = useLocalState('count', 0);

// Callbacks are memoized automatically
const increment = useCallback(() => setCount(c => c + 1), [setCount]);

Memory Management

Automatic cleanup prevents memory leaks:

// Broadcast channels are automatically cleaned up on unmount
const [message, postMessage] = useBroadcastChannel('channel');

// Event listeners are properly removed
const isMobile = useIsMobile();

📱 Framework Integration

Next.js

// Full SSR support with App Router
import { useLocalState } from '@geee-be/react-utils';

export default function Page() {
  const [data, setData] = useLocalState('page-data', null);
  return <div>{data?.title}</div>;
}

Remix

import { useIsClient } from '@geee-be/react-utils';

export default function RemixRoute() {
  const isClient = useIsClient();
  return isClient ? <ClientFeature /> : <ServerFallback />;
}

Vite/SPA

// Works great in client-side apps too
import { useHistoryState } from '@geee-be/react-utils';

function SinglePageApp() {
  const [route, setRoute] = useHistoryState('route', '/');
  return <Router currentRoute={route} />;
}

🔧 TypeScript Support

Full TypeScript support with comprehensive type definitions:

import { useLocalState } from '@geee-be/react-utils';

interface UserPreferences {
  theme: 'light' | 'dark';
  language: string;
  notifications: boolean;
}

function UserSettings() {
  // Type is automatically inferred as [UserPreferences, (value: UserPreferences) => void]
  const [prefs, setPrefs] = useLocalState<UserPreferences>('user-prefs', {
    theme: 'light',
    language: 'en',
    notifications: true
  });

  // TypeScript will ensure type safety
  const toggleTheme = () => {
    setPrefs(prev => ({
      ...prev,
      theme: prev.theme === 'light' ? 'dark' : 'light'
    }));
  };

  return <button onClick={toggleTheme}>Toggle Theme</button>;
}

@geee-be/react-twui - UI component library that uses these utilities
@uidotdev/usehooks - Additional React hooks (included as dependency)

📄 License

MIT License - see LICENSE file for details.

🐛 Issues & Support

Found a bug or need help? Please open an issue on GitHub.

Package detail