> For the complete documentation index, see [llms.txt](https://rangle.gitbook.io/redux-beacon/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rangle.gitbook.io/redux-beacon/index-2/offline-web.md).

# OfflineWeb

An offline storage extension that records analytics events in [indexedDB](https://developer.mozilla.org/en/docs/Web/API/IndexedDB_API) when offline, and resyncs those events when back online. The extension adds a timestamp to each saved extension under the `timeSaved` key.

Like all offline storage extensions, this extension expects that you're already storing a connectivity flag in your app's state.

## Installation

```bash
npm install --save @redux-beacon/offline-web
```

## Import

```javascript
import OfflineWeb from '@redux-beacon/offline-web';
```

## Usage

### Step 1

The first step is to track the connection status in your state. Here's an example of how you would do so using browser's in-built [offline and online events](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/Online_and_offline_events):

```javascript
const initialState = {
  isConnected: true, // by default the app is assumed to have a connection
}

function reducer(state = initialState, action) {
  switch (action.type) {
    case 'UPDATE_CONNECTIVITY' {
      return Object.assign({}, state, { isConnected: action.payload });
    }
    ...
    default:
      return state;
  }
}

window.addEventListener('offline', () => {
  store.dispatch({
    type: 'UPDATE_CONNECTIVITY',
    payload: false,
  });
});

window.addEventListener('online', () => {
  store.dispatch({
    type: 'UPDATE_CONNECTIVITY',
    payload: true,
  });
});
```

### Step 2

Create a connectivity selector that accepts the state, and returns your app's connection status:

```javascript
const isConnected = state => state.isConnected;
```

The connectivity selector should return a boolean:

* `true` when the app is online
* `false` when the app is offline

### Step 3

Initialize the extension and provide it when creating a middleware or meta reducer:

```javascript
import OfflineWeb from '@redux-beacon/offline-web';

// Pass the connectivity selector from Step 2 as the first parameter
const offlineStorage = offlineWeb(isConnected);

// Create or import an events map and target.
// See "getting started" pages for instructions.

const middleware = createMiddleware(eventsMap, target, { offlineStorage });
const metaReducer = createMetaReducer(eventsMap, target, { offlineStorage });
```

Now, whenever your app loses connection, your analytics events will now be saved offline until it regains its connection.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://rangle.gitbook.io/redux-beacon/index-2/offline-web.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.