#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.
• useRouterState - Subscribes to the router's live state - the matched route, its params and

#Providers

• ReactBrowserRendererProvider - Browser specific React renderer (react-dom/client interface)
• ReactBrowserRouterProvider - Implementation of AlephaRouter for React in browser environment.
• ReactDomServerProvider - The renderer half of React, loaded only once something actually renders.
• ReactPageProvider - Handle page routes for React applications. (Browser and Server)
• ReactPreloadProvider - Adds HTTP Link headers for preloading entry assets.
• ReactServerErrorProvider - Answers a browser navigation with an HTML error page instead of JSON.
• ReactServerProvider - React server provider responsible for SSR and static file serving.
• ReactServerTemplateProvider - Handles HTML streaming for SSR.
• RootComponentsProvider - Extension point letting any module contribute root-level React nodes that
• RouterLocaleProvider - Generic locale path-prefix mechanism for the router.
• SSRManifestProvider - Provider for SSR manifest data used for module preloading.

#Environment Variables

Environment variables used to configure this module. These can be set in your .env file or through your deployment configuration.