CJY0208/react-router-cache-route
React Router Cache Route
React-router-cache-route is a client-side route state manager and component caching library for React Router applications. It preserves component state, local Document Object Model structures, and view containers across route changes to prevent unmounting during navigation.
The library includes LRU-based cache capacity limiting to automatically prune older entries and manage memory consumption when handling multiple dynamic route instances. It provides declarative route matching rules using conditional strings or custom functions, alongside an automatic scroll position persistence engine that saves and restores horizontal and vertical scroll coordinates when views activate and deactivate.
Additional capabilities include imperative cache store management for clearing specific route keys or wiping the entire cache store at runtime, component lifecycle hook injection for triggering custom callbacks during cache entry and recovery phases, and configurable wrapper styles for cached elements.
Features
- Route View Caches - Preserves component state and DOM structures across route changes in React applications, preventing unnecessary unmounting.
- Detachment and Reattachment - Preserves component state and local DOM trees during navigation by detaching inactive views from the live document rather than unmounting them.
- Runtime Cache Clears - Provides imperative methods to clear specific route keys or wipe the entire cache store at runtime.
- Router Cache Components - Acts as a routing extension for React Router that preserves component state and DOM structures during navigation.
- Scroll Restoration - Saves and restores the scroll positions of cached route views during navigation to maintain user context and smooth performance.
- Scroll Position Maintenance - Save and restore the scroll position of cached route components even when underlying Document Object Model nodes unmount to optimize performance.
- Scroll Position Persistence Engines - Saves and restores horizontal and vertical scroll coordinates of cached view containers when components activate or deactivate during navigation.
- View State Preservation - Preserves component state and DOM structures by detaching unmounted views from the render tree and reattaching them during navigation.
- Route State Caching - Manages multiple cached instances of parameterized routes with custom limits and keys to automatically prune older entries.
- Manual Cache Clearing - Force the removal of specific cached route entries using custom keys or clear the entire cache programmatically at runtime.
- Store Management - Exposes programmatic utility methods to clear specific route keys or wipe the entire component cache store directly at runtime.
- Cache Behavior Configurators - Determine when routes undergo caching using conditional strings or functions while customizing wrapper element styles and rendering behavior.
- Cache - Execute custom logic via component hooks whenever cached elements enter storage or recover from it.
- Functional Lifecycle Hooks - Triggers user-defined callback functions during cache entry and recovery phases across both functional hooks and class component wrappers.
- LRU Cache Eviction - Manages memory consumption by enforcing a maximum count of stored route instances and automatically evicting older entries.
- Capacity Limitations - Enforces a strict upper bound on stored route instances by automatically evicting the oldest cached entries when memory limits are reached.
- Component Lifecycle Hooks - Triggers custom callbacks during cache entry and recovery phases across both functional hooks and class component wrappers.
- Component Caching Libraries - Maintains component state across view transitions with LRU cache capacity limiting and automatic pruning of older entries.
- Custom Matching Logic - Evaluates conditional strings, functions, or custom matching logic to determine which child route components are targeted for caching.
- View Transition State Managers - Maintains component state and DOM structures across view transitions in single-page applications to prevent unmounting.
- Route Caching Extensions - Caches route components with configurable limits, scroll position persistence, and programmatic cache clearing.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
