turbolinks/turbolinksArchived
Turbolinks
Turbolinks is a JavaScript library that accelerates HTML page transitions by replacing the page body via network requests instead of performing full browser refreshes. It functions as a client-side navigation manager that intercepts link clicks and controls the page visit lifecycle to simulate a single-page application experience.
The library synchronizes the browser URL and history stack with partial page updates and utilizes a caching mechanism to store visited page states. This allow for instant previews and restoration of state when navigating backward or forward. It also includes a tool for transferring specific UI elements across transitions by matching identifiers to maintain element persistence.
The project covers navigation lifecycle management, including the ability to intercept visits and configure custom headers. It provides a customizable progress bar for asynchronous loads and monitors asset versioning to trigger full page reloads when scripts or styles are updated. Navigation scope can be configured to restrict partial updates to specific root paths or origins.
Features
- Partial Page Refreshers - Replaces the page body via XHR network requests instead of performing full browser refreshes.
- Navigation Acceleration - Accelerates page navigation by replacing the page body using network requests and browser history.
- Single Page Applications - Simulates the speed of a single page app by replacing the page body instead of performing full browser refreshes.
- Persistent UI Components - Keeps specific UI elements active across navigation by matching identifiers and transferring them to the subsequent page.
- Browser History Management - Synchronizes the browser URL and history stack with partial page updates to maintain standard navigation behavior.
- Navigation Hooks - Provides a sequence of lifecycle hooks from visit to render, allowing developers to intercept or modify navigation.
- Client-Side Page Caching - Stores copies of visited pages to provide instant previews during navigation and restore state when moving backward or forward.
- Navigable Lifecycles - Triggers sequential events from click to render, allowing the interception of visits and post-load script execution.
- Navigation Preview Caching - Stores visited page states to provide instant previews when users navigate backward or forward.
- Page State Snapshots - Stores a copy of the previous page state to allow instant backward navigation without new network requests.
- Page Transition Controls - Accelerates navigation by replacing page bodies via network requests instead of full browser refreshes.
- Client-Side Navigation Management - Intercepts browser clicks to manage custom headers and execute specific scripts during the page loading lifecycle.
- UI Element Persistence - Matches elements by their ID across page loads to keep specific UI components active and consistent during transitions.
- Cross-Page Element Persistence - Keeps specific UI elements active across page transitions by matching identifiers and transferring them to new views.
- UI State Persistence - Keeps specific UI elements active and consistent across different pages to prevent flickering or loss of user state.
- Version-Triggered Reloads - Triggers full page reloads when asset version mismatches are detected to ensure the latest scripts and styles are loaded.
- Navigation Scope Controls - Provides configuration to restrict partial page updates to specific root paths or origins.
- Page Speed Optimizations - Speeds up the transition between pages by caching visited content and managing network requests for body updates.
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.
