r3-utils

A specialized library of reusable hooks, utilities, and components designed specifically for Remix or React Router based applications

Prerequisites

• React Router v7.3.0 or higher
• React v19.0.0 or compatible version

Installation

# Using npm
npm install r3-utils

# Using yarn
yarn add r3-utils

# Using pnpm
pnpm add r3-utils

And if you are using RedisStorageAdapter make sure ioredis package is installed

Features

• 🪝 Hooks: Custom React hooks for working with React Router and common web application patterns
• 🛠️ Utilities: Helper functions for common tasks like error handling, data validation, and query parameter manipulation
• 🧩 Components: Reusable React components that extend React Router functionality
• 📦 Submodule Imports: Import only what you need from specific submodules

Submodule Imports

You can import directly from submodules to improve code organization and potentially reduce bundle size:

// Import from specific submodules
import { CacheClient, CacheProvider } from "@bonny-kato/r3-utils/cache";
import { useBreadcrumb, useDebounce } from "@bonny-kato/r3-utils/hooks";
import { removeNullish, parseError } from "@bonny-kato/r3-utils/utils";

Available submodules:

• r3-utils/auth
• r3-utils/cache
• r3-utils/access-control
• r3-utils/hooks
• r3-utils/http-client
• r3-utils/utils
• r3-utils/zod-common

For more details, see SUBMODULE_IMPORTS.md.

Each submodule has its own README file with detailed documentation.

Module Documentation

Each submodule has its own README file with detailed documentation. Please refer to the individual module README files for comprehensive information about the available utilities, hooks, and components:

• Auth Module - Authentication utilities and storage adapters
• Cache Module - Data caching utilities
• Access Control Module - User permissions management
• Hooks Module - React hooks for React Router
• HTTP Client Module - API request utilities
• Utils Module - Helper functions
• Zod Common Module - Zod schemas

Development

# Install dependencies
pnpm install

# Build the library
pnpm build

# Run linting
pnpm lint

# Format code
pnpm format

License

MIT