doc22940 / react-native-netinfo

@react-native-community/netinfo

React Native Network Info API for Android & iOS. It allows you to get information on:

• Online/offline status
• Connection type
• Connection quality

Getting started

Install the library using either Yarn:

yarn add @react-native-community/netinfo

or npm:

npm install --save @react-native-community/netinfo

You then need to link the native parts of the library for the platforms you are using. The easiest way to link the library is using the CLI tool by running this command from the root of your project:

react-native link @react-native-community/netinfo

If you can't or don't want to use the CLI tool, you can also manually link the library on iOS using the intructions in the React Native documentation. On Android you can make the following changes to link the library (click on the arrow to show them):

Manually link the library on Android

android/settings.gradle

include ':@react-native-community/netinfo'
project(':@react-native-community/netinfo').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-community/netinfo/android')

android/app/build.gradle

dependencies {
   ...
   implementation project(':@react-native-community/netinfo')
}

android/app/src/main/.../MainApplication.java

On top, where imports are:

import com.reactnativecommunity.netinfo.NetInfoPackage;

Add the RNLocationPackage class to your list of exported packages.

@Override
protected List<ReactPackage> getPackages() {
    return Arrays.asList(
            new MainReactPackage(),
            new NetInfoPackage()
    );
}

Migrating from the core react-native module

This module was created when the NetInfo was split out from the core of React Native. To migrate to this module you need to follow the installation instructions above and then change you imports from:

import { NetInfo } from "react-native";

to:

import NetInfo from "@react-native-community/netinfo";

Usage

Start by importing the library:

import NetInfo from "@react-native-community/netinfo";

Get connection info

Returns a promise that resolves to an object with type and effectiveType keys whose values are a ConnectionType and an EffectiveConnectionType), respectively.

NetInfo.getConnectionInfo().then(connectionInfo => {
  console.log("Connection type", connectionInfo.type);
  console.log("Connection effective type", connectionInfo.effectiveType);
});

ConnectionType

Cross platform values:

• none - Device is offline
• wifi - Device is online and connected via wifi, or is the iOS simulator
• cellular - Device is connected via Edge, 3G, WiMax, or LTE
• unknown - Error case and the network status is unknown

Android-only values:

• bluetooth - Device is connected via Bluetooth
• ethernet - Device is connected via Ethernet
• wimax - Device is connected via WiMAX

EffectiveConnectionType

Cross platform values:

• 2g
• 3g
• 4g
• unknown

Subscribe to connection info

Subscribe to connection information. The callback is called whenever the connection status changes. The returned object shape is the same as getConnectionInfo above.

const listener = connectionInfo => {
  console.log("Connection type", connectionInfo.type);
  console.log("Connection effective type", connectionInfo.effectiveType);
};

// Subscribe
const subscription = NetInfo.addEventListener('connectionChange', listener);

// Unsubscribe through remove
subscription.remove();

// Unsubscribe through event name
NetInfo.removeEventListener('connectionChange', listener);

Is connected

Returns a promise that resolves to a boolean which says if there is an active connection.

Note: This only says if a device has an active connection, not that it is able to reach the internet.

Getting the connection status once:

NetInfo.isConnected.fetch().then(isConnected => {
  console.log("Is connected", isConnected);
});

Or subscribing to changes:

const listener = isConnected => {
  console.log("Is connected", isConnected);
};

// Subscribe
const subscription = NetInfo.isConnected.addEventListener('connectionChange', listener);

// Unsubscribe through remove
subscription.remove();

// Unsubscribe through event name
NetInfo.isConnected.removeEventListener('connectionChange', listener);

Is connection expensive (Android only)

Detect if the current active connection is metered or not. A network is classified as metered when the user is sensitive to heavy data usage on that connection due to monetary costs, data limitations or battery/performance issues.

NetInfo.isConnectionExpensive().then(isConnectionExpensive => {
  console.log("Is connection expensive", isConnectionExpensive);
});

Maintainers

• Matt Oakes

License

The library is released under the MIT licence. For more information see LICENSE.