react-native-offline
Handful of utilities you should keep in your toolbelt to handle offline/online connectivity in React Native. It supports iOS, Android and Windows platforms. You can leverage all the functionalities provided or just the ones that suits your needs, the modules are conveniently decoupled.
Important (Please read)
This is the documentation for version 4.0.0-beta.0. If you are migrating from v3 to v4, check the release notes
Please try to use v4. Some of the core has been rewritten from scratch using TDD approach and it fixes some of the outstanding issues that v3 presented. If you are using RN v0.56 or higher v3 won't work. Don't be misled by the word beta, it's a precaution measure that I've set myself because I am human and I may have made some unwitting mistake
That being said, if you still want to use v3, go here.
Contents
Motivation
When you are building your React Native app, you have to expect that some users may use your application in offline mode, for instance when travelling on a Plane (airplane mode) or the underground (no signal). How does your app behave in that situation? Does it show an infinite loader? Can the user still use it seamlessly?
Having an offline first class citizen app is very important for a successful user experience. React Native ships with the NetInfo module in order to detect internet connectivity. The API is pretty basic and it may be sufficient for small apps but its usage gets cumbersome as your app grows. Besides that, it only detects network connectivity and does not guarantee internet access so it can provide false positives.
This library aims to gather a variety of modules that follow React and Redux best practises, in order to make your life easier when it comes to deal with internet connectivity in your React Native application.
Features
- Offline/online conditional rendering through Provider/Consumer components that leverage the new React Context API
- Reducer to keep your connectivity state in the Redux store
- Redux middleware to intercept internet request actions in offline mode and apply DRY principle
- Compatibility with async middleware libraries like redux-thunk, redux-saga and redux-observable
- A saga to place the network event subscriptions outside of your components
- A step further than
NetInfodetecting internet access besides network connectivity - Offline queue support to automatically re-dispatch actions when connection is back online or dismiss actions based on other actions dispatched (i.e navigation related)
- Ability to check connectivity regularly
- 100% unit test coverage
Contributions
PRs are more than welcome. If you're planning to contribute please make sure to read the contributing guide: CONTRIBUTING.md
Sponsors
If you use this library on your commercial/personal projects, you can help us by funding the work on specific issues that you choose by using IssueHunt.io!
This gives you the power to prioritize our work and support the project contributors. Moreover it'll guarantee the project will be updated and maintained in the long run.
Sponsors will be listed in the contributors section at the bottom. If you want to be removed please contact me at: rauliyohmc@gmail.com
Installation
This library supports React Native v0.55 or higher.
$ yarn add react-native-offline@4.0.0-beta.0
Android
This library uses the NetInfo module from React Native underneath the hood. To request network info in Android an extra step is required, so you should add the following line to your app's AndroidManifest.xml as well:
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
API
Component Utilities
In order to render stuff conditionally with ease. They internally listen to connection changes and also provide an extra layer of reliability by ensuring there is internet access when reporting online. For that, an extra request is made to a remote server.
NetworkProvider
Provider component that injects the network state to children components via React Context. Only children prop is required, the rest are optional. It should be used on top of your components hierarchy, ideally in (or close to) the entry point.
type Props = {
children: React.Node,
pingTimeout?: number = 3000,
pingServerUrl?: string = 'https://www.google.com/',
shouldPing?: boolean = true,
pingInterval?: number = 0,
pingOnlyIfOffline?: boolean = false,
pingInBackground?: boolean = false,
httpMethod?: HTTPMethod = 'HEAD',
}Config
children: a React Element. This is the only required prop.
pingTimeout: amount of time (in ms) that the component should wait for the ping response. Defaults to 3000 ms.
pingServerUrl: remote server to ping to. Defaults to https://www.google.com/ since it's probably one the most stable servers out there, but you can provide your own if needed.
shouldPing: flag that denotes whether the extra ping check will be performed or not. Defaults to true.
pingInterval: the interval (in ms) you want to ping the server at. Defaults to 0, and that means it is not going to check connectivity regularly.
pingOnlyIfOffline: when set to true and pingInterval > 0, it will ping the remote server regularly only if offline. Defaults to false.
pingInBackground: whether or not to check connectivity when app isn't in the foreground. Defaults to false.
httpMethod: http method used to ping the server. Supports HEAD or OPTIONS. Defaults to HEAD.
Usage
// index.js
import React from 'react';
import { NetworkProvider } from 'react-native-offline';
import App from './App';
const Root = () => (
<NetworkProvider>
<App />
</NetworkProvider>
);
export default Root;NetworkConsumer
React component that subscribes to connectivity changes. It requires a function as a child. The function receives the current connectivity status and returns a React node. This component should be rendered within a NetworkProvider in order to work properly.
Props
type NetworkState = {
isConnected: boolean,
}
type Props = {
children: ({ isConnected }: NetworkState) => React.Node
}Usage
import React from 'react';
import { Image, Button, Text } from 'react-native';
import { NetworkConsumer } from 'react-native-offline';
const ImageViewer = () => (
<View>
<Image src="foo.com" />
<NetworkConsumer>
{({ isConnected }) => (
isConnected ? (
<Button title="Download image" onPress={downloadImage} />
) : (
<Text>Downloading images is disabled since you are offline</Text>
)
)}
</NetworkConsumer>
</View>
);Integration with Redux
There are 3 features that this library provides in order to leverage offline capabilities in your Redux store: a reducer, a middleware and an offline queue system. You can use all of them or just the ones that suits your needs.
Network reducer
A network reducer to be provided to the store.
State
type NetworkState = {
isConnected: boolean,
actionQueue: Array<*>
}Usage
1.- Give the network reducer to Redux
// configureStore.js
import { createStore, combineReducers } from 'redux'
import { reducer as network } from 'react-native-offline';
const rootReducer = combineReducers({
// ... your other reducers here ...
network,
});
const store = createStore(rootReducer);
export default store;2.- Here you have 2 options:
ReduxNetworkProvider
Uses a provider component mechanism. The same props as for NetworkProvider apply. Make sure your component is a descendant of the react-redux <Provider> component, so that ReduxNetworkProvider has access to the store.
// Root.js
import store from './reduxStore';
import React from 'react';
import { Provider } from 'react-redux';
import { ReduxNetworkProvider } from 'react-native-offline';
let App = () => (
<Navigator>
<MainScreen />
<OtherScreen />
</Navigator>
);
const Root = () => (
<Provider store={store}>
<ReduxNetworkProvider>
<App />
</ReduxNetworkProvider>
</Provider>
);networkSaga
Just fork this saga from your root saga. It accepts the same config options as NetworkProvider and ReduxNetworkProvider. Recommended if you are using redux-saga, since it's a very elegant way to deal with global connectivity changes, without having to wrap your components with extra functionality.
// rootSaga.js
import { all } from 'redux-saga/effects';
import saga1 from './saga1';
import saga2 from './saga2';
import { networkSaga } from 'react-native-offline';
export default function* rootSaga(): Generator<*, *, *> {
yield all([
fork(saga1),
fork(saga2),
fork(networkSaga, { pingTimeout: 2000, checkConnectionInterval: 20000 }),
]);
}3.- Access your network state in your components using mapStateToProps(), as state.network.isConnected.
Note: If you wanna listen to the action dispatched internally in your reducers, import the offline action types and reference CONNECTION_CHANGE:
import { offlineActionTypes } from 'react-native-offline';
...
if(action.type === offlineActionTypes.CONNECTION_CHANGE) // do something in your reducer
...createNetworkMiddleware()
Function that returns a Redux middleware which listens to specific actions targeting API calls in online/offline mode.
createNetworkMiddleware(config: MiddlewareConfig): ReduxMiddleware
type MiddlewareConfig = {
regexActionType?: RegExp = /FETCH.*REQUEST/,
actionTypes?: Array<string> = []
}PO Config
This is the setup you need to put in place for libraries such as redux-saga or redux-observable, which rely on plain actions being dispatched to trigger async flow:
regexActionType: regular expression to indicate the action types to be intercepted in offline mode.
By default it's configured to intercept actions for fetching data following the Redux convention. That means that it will intercept actions with types such as FETCH_USER_ID_REQUEST, FETCH_PRODUCTS_REQUEST etc.
actionTypes: array with additional action types to intercept that don't fulfil the RegExp criteria. For instance, it's useful for actions that carry along refreshing data, such as REFRESH_LIST.
Thunks Config
For redux-thunk library, the async flow is wrapped inside functions that will be lazily evaluated when dispatched, so our store is able to dispatch functions as well. Therefore, the configuration differs:
- Make sure to use a named function instead of an anonymous arrow function for the thunk returned by your action creator.
- Use
interceptInOfflineproperty in your thunk and set it totrue.
Example:
export const fetchUser = (url) => {
function thunk(dispatch) {
fetch(url)
.then((response) => response.json())
.then((responseJson) => {
dispatch({type: FETCH_USER_SUCCESS, payload: responseJson});
})
.catch((error) => {
console.error(error);
});
};
thunk.interceptInOffline = true; // This is the important part
return thunk; // Return it afterwards
};Usage
You should apply the middleware to the store using applyMiddleware. The network middleware should be the first on the chain, before any other middleware used for handling async actions, such as redux-thunk, redux-saga or redux-observable.
import { createStore, applyMiddleware } from 'redux';
import { createNetworkMiddleware } from 'react-native-offline';
import createSagaMiddleware from 'redux-saga';
const sagaMiddleware = createSagaMiddleware();
const networkMiddleware = createNetworkMiddleware();
const store = createStore(
rootReducer,
applyMiddleware(networkMiddleware, sagaMiddleware)
);When you attempt to fetch data on the internet by means of dispatching a plain action or a thunk in offline mode, the middleware blocks the action and dispatches an action of type @@network-connectivity/FETCH_OFFLINE_MODE instead, containing useful information about "what you attempted to do". The action dispatched signature for plain objects is as follows:
type FetchOfflineModeActionForPO = {
type: '@@network-connectivity/FETCH_OFFLINE_MODE',
payload: {
prevAction: {
type: string, // Your previous action type
payload?: any, // Your previous payload
}
}
}And for thunks it attaches it under prevThunk property:
type FetchOfflineModeActionForThunks = {
type: '@@network-connectivity/FETCH_OFFLINE_MODE',
payload: {
prevThunk: Function
}
}That allows you to react conveniently and update your state in the way you desire, based on your previous intent. Just reference FETCH_OFFLINE_MODE action type in your reducer:
import { offlineActionTypes } from 'react-native-offline';
...
if(action.type === offlineActionTypes.FETCH_OFFLINE_MODE) // do something in your reducer
...SnackBars, Dialog, Popups, or simple informative text are good means of conveying to the user that the operation failed due to lack of internet connection.
Offline Queue
A queue system to store actions that failed due to lack of connectivity. It works for both plain object actions and thunks. It allows you to:
- Re-dispatch the action/thunk as soon as the internet connection is back online again
- Dismiss the action from the queue based on a different action dispatched (i.e. navigating to a different screen, the fetch action is no longer relevant)
Plain Objects
In order to configure your PO actions to interact with the offline queue you need to use the meta property in your actions, following flux standard actions convention. They need to adhere to the below API:
type ActionToBeQueued = {
type: string,
payload?: any,
meta: {
retry?: boolean, // By passing true, your action will be enqueued on offline mode
dismiss?: Array<string> // Array of actions which, once dispatched, will trigger a dismissal from the queue
}
}Examples
- Action that will be added to the queue on offline mode and that will be re-dispatched as soon as the connection is back online again
const action = {
type: 'FETCH_USER_ID',
payload: {
id: 2
},
meta: {
retry: true
}
};- Action that will be added to the queue on offline mode and that will be re-dispatched as soon as the connection is back online again, as long as a
NAVIGATE_BACKaction type hasn't been dispatched in between, in which case the action would be removed from the queue.
const action = {
type: 'FETCH_USER_ID',
payload: {
id: 2
},
meta: {
retry: true,
dismiss: ['NAVIGATE_BACK']
}
};Thunks
- For thunks, append
interceptInOfflineandmetaproperties to the function returned by the action creator, wheremetahas the same shape as for Flux actions:
function fetchData(dispatch, getState) {
dispatch({ type: FETCH_USER_ID_REQUEST, payload: { id: '3' } });
...
}
fetchData.interceptInOffline = true; // In order to be intercepted by the middleware
fetchData.meta = {
retry?: boolean, // By passing true, your thunk will be enqueued on offline mode
dismiss?: Array<string> // Array of actions which, once dispatched, will trigger a dismissal from the queue
}Other utilities
checkInternetConnection()
Utility function that allows you to query for internet connectivity on demand. If you have integrated this library with redux, you can then dispatch a CONNECTION_CHANGE action type to inform the network reducer accordingly and keep it up to date. Check the example below.
checkInternetConnection(url?: string = 'https://www.google.com/', pingTimeout?: number = 3000): Promise<boolean>Example
import { checkInternetConnection, offlineActionTypes } from 'react-native-offline';
async function internetChecker(dispatch) {
const isConnected = await checkInternetConnection();
// Dispatching can be done inside a connected component, a thunk (where dispatch is injected), saga, or any sort of middleware
// In this example we are using a thunk
dispatch({
type: offlineActionTypes.CONNECTION_CHANGE,
payload: isConnected,
});
}Miscellanea
FAQ
How to test offline behavior while actually being online
You can use pingServerUrl and set it to a non existing url or point to some server that is down.
How to orchestrate Redux to dispatch CONNECTION_CHANGE as the first action when the app starts up
The solution involves using some local state in your top most component and tweaking the configureStore function a bit, so that it can notify your root React component to render the whole application when the required initialisation has taken place. In this case, by initialisation, we are talking about rehydrating the store from disk and detecting initial internet connection.
As you can see in the snippets below, we create the store instance as usual and return it in our configureStore function. The only difference is that the function is still alive and will invoke the callback as soon as 2 actions are dispatched into the store (in order):
REHYDRATEfromredux-persistCONNECTION_CHANGEfromreact-native-offline
// configureStore.js
import { AsyncStorage, Platform, NetInfo } from 'react-native';
import { createStore, applyMiddleware, compose } from 'redux';
import { persistStore, autoRehydrate } from 'redux-persist';
import { createNetworkMiddleware, offlineActionTypes, checkInternetConnection } from 'react-native-offline';
import rootReducer from '../reducers';
const networkMiddleware = createNetworkMiddleware();
export default function configureStore(callback) {
const store = createStore(
rootReducer,
undefined,
compose(
applyMiddleware(networkMiddleware),
autoRehydrate(),
),
);
// https://github.com/rt2zz/redux-persist#persiststorestore-config-callback
persistStore(
store,
{
storage: AsyncStorage,
debounce: 500,
},
() => {
// After rehydration completes, we detect initial connection
checkInternetConnection().then(isConnected => {
store.dispatch({
type: offlineActionTypes.CONNECTION_CHANGE,
payload: isConnected,
});
callback(); // Notify our root component we are good to go, so that we can render our app
});
},
);
return store;
}Then, our root React component will have some local state, that initially will impose the component to return null, waiting until the async operations complete. Then, we trigger a setState to render the application.
// App.js
import React, { Component } from 'react';
import { Provider } from 'react-redux';
import configureStore from './store';
import Root from './Root';
class App extends Component {
constructor(props) {
super(props);
this.state = {
isLoading: true,
store: configureStore(() => this.setState({ isLoading: false })),
};
}
render() {
if (this.state.isLoading) return null;
return (
<Provider store={this.state.store}>
<Root />
</Provider>
);
}
}
export default App;This way, we make sure the right actions are dispatched before anything else can be.
How to intercept and queue actions when the server responds with client (4xx) or server (5xx) errors
You can do that by dispatching yourself an action of type @@network-connectivity/FETCH_OFFLINE_MODE. The action types the library uses are exposed under offlineActionTypes property.
Unfortunately, the action creators are not exposed yet, so I'll release soon a new version with that fixed. In the meantime, you can check that specific action creator in here, so that you can emulate its payload. That should queue up your action properly.
import { offlineActionTypes } from 'react-native-offline';
...
fetch('someurl/data').catch(error => {
dispatch({
type: actionTypes.FETCH_OFFLINE_MODE,
payload: {
prevAction: {
type: action.type, // <-- action is the one that triggered your api call
payload: action.payload,
},
},
meta: { retry: true }
})
);How to persist and rehydrate thunks in the offline queue with Redux Persist
Due to the way Redux Persist serializes the store, persisting and rehydrating thunks will return an invalid action. Fortunately, there is a workaround.
In your action creator, make sure to format it as specified from the thunks config with a couple of additions.
// actions.js
export const fetchUser = (url) => {
function thunk(dispatch) {
fetch(url)
.then((response) => response.json())
.then((responseJson) => {
dispatch({type: FETCH_USER_SUCCESS, payload: responseJson});
})
.catch((error) => {
console.error(error);
});
};
thunk.interceptInOffline = true;
// Add these
thunk.meta = {
retry: true,
name: 'fetchUser', // This should be the name of your function
args: [url], // These are the arguments for the function. Add more as needed.
};
return thunk;
};Add the following into your redux store. Refer to the transforms section for more information on how Redux Persist transforms data.
// store.js
import { fetchUser } from './actions.js';
import { fetchOtherUsers } from './otherActions.js';
// We have to map our actions to an object
const actions = {
fetchUser,
fetchOtherUsers,
};
// Transform how the persistor reads the network state
const networkTransform = createTransform(
(inboundState, key) => {
const actionQueue = [];
inboundState.actionQueue.forEach(action => {
if (typeof action === 'function') {
actionQueue.push({
function: action.meta.name,
args: action.meta.args,
});
} else if (typeof action === 'object') {
actionQueue.push(action);
}
});
return {
...inboundState,
actionQueue,
};
},
(outboundState, key) => {
const actionQueue = [];
outboundState.actionQueue.forEach(action => {
if (action.function) {
const actionFunction = actions[action.function];
actionQueue.push(actionFunction(...action.args));
} else {
actionQueue.push(action);
}
});
return { ...outboundState, actionQueue };
},
// The 'network' key may change depending on what you
// named your network reducer.
{ whitelist: ['network'] },
);
const persistConfig = {
key: 'root',
storage,
transforms: [networkTransform], // Add the transform into the persist config
};Inspiration
Thanks to Spencer Carli for his awesome article about Handling Offline actions in React Native, which served me as inspiration for the offline queue implementation.
License
MIT
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!