Skip to content

rauchy/react-native-offline-mode

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

react-native-offline-mode

A higher-order component for React Native which will conditionally show a component OR something else depending on internet connection availability.

[ScreenShot]

Install

Make sure that you are in your React Native project directory and run:

npm install react-native-offline-mode --save

Usage

Import RequiresConnection as a JavaScript module:

import RequiresConnection from 'react-native-offline-mode';

Then simply wrap whichever component you want to be connection-aware with a call to RequiresConnection. Take a look at the example project or simply this commit.

Showing a default "no connectivity" message

For example, if you want the entire app to go on hold with a "no connectivity" message, simply wrap your main component:

module.exports = RequiresConnection(Main)

Specifying a custom message

If you want to display a different message, simply pass it as a second parameter to RequiresConnection:

module.exports = RequiresConnection(Main, 'no internetz for you :(')

Using a custom offline component

Instead of just showing a message, you can have your app deliver different functionality when offline. To accomplish this, simply pass in the offline component as a second parameter:

module.exports = RequiresConnection(OnlineMain, OfflineMain)

Contributing

  1. Fork it ( https://github.com/rauchy/react-native-offline-mode/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

Swap your app with an offline version while there's no connectivity

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •