alepha@docs:~/docs/packages/alepha/react$
cat router.md | pretty
2 min read
Last commit:

#Alepha - React Router

#Installation

Part of the alepha package. Import from alepha/react/router.

npm install alepha

#Overview

Provides declarative routing with the $page primitive for building type-safe React routes.

This module enables:

  • URL pattern matching with parameters (e.g., /users/:id)
  • Nested routing with parent-child relationships
  • Type-safe URL parameter and query string validation
  • Server-side data fetching with the loader function
  • Lazy loading and code splitting
  • Page animations and error handling

#API Reference

#Primitives

  • $page — Main primitive for defining a React route in the application.

#React Hooks

  • useActive — Hook to determine if a given route is active and to provide anchor props for navigation.
  • useQueryParams — Hook to manage query parameters in the URL using a defined schema.
  • useRouter — Use this hook to access the React Router instance.

#Providers