HubSpot/offlineArchived
Offline
Offline is a JavaScript library that provides an offline-first framework for web applications, centered on monitoring network connectivity and managing the application's response to connection state changes. It detects transitions between online and offline states by listening to browser events and emits custom events that allow other parts of the application to react accordingly.
The library distinguishes itself by combining event-driven connectivity detection with automatic request queuing and retry. When a request fails due to lost connectivity, it is captured and queued in memory, then automatically replayed in order once the network connection is restored. It also includes periodic connectivity probing, which sends lightweight HTTP requests to a known endpoint to verify actual network reachability beyond the browser's own event signals.
Offline provides a visual status indicator that automatically updates to reflect the current online or offline state, and its custom event bus enables decoupled components to respond to connection up, down, and reconnection attempts. The library's documentation covers installation and integration for adding these capabilities to web applications.
Features
- Offline-First Web Apps - Provides tools for handling network interruptions in web applications as an offline-first JavaScript library.
- Network State Emitters - Fires custom events when the browser transitions between online and offline states.
- Request Retries - Automatically retries AJAX requests that fail due to lost connectivity upon reconnection.
- Bulk Retry on Reconnect - Bulk-retries all queued failed requests immediately upon detecting a transition from offline to online.
- Connection Lifecycle Events - Binds custom event handlers to online, offline, and reconnection lifecycle events.
- Endpoint Reachability Probes - Checking current connectivity by sending test requests to a resource and evaluating the response.
- Event Handling - Fires custom events when network state changes for implementing custom offline/online behaviors.
- Offline Request Queues - Queues AJAX requests made while offline and resends them when the connection is restored.
- Connectivity Verification Probes - Periodically sends a lightweight HTTP request to a known endpoint to verify actual network reachability beyond browser event signals.
- Network Connectivity Event Dispatchers - Detects network state changes by listening to browser online and offline events and dispatching custom events for application-level handling.
- Network Connectivity Monitoring - Detects and reports changes in browser online and offline status to applications.
- Event Bus Architectures - Emits named events for connection up, down, and reconnection attempts for decoupled components.
- Connection Status Indicators - Displays a visual indicator that updates automatically to reflect the current online or offline state.
- Visual Status Indicators - Shows an automatic visual cue that reflects the current network state without manual user intervention.
- Network Status Indicators - Renders a persistent UI element that reflects the current online or offline status, updating automatically on state transitions.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
