@react-native-community/netinfo

What is @react-native-community/netinfo?

@react-native-community/netinfo is a React Native library that provides information about the device's network connection state. It allows developers to detect the type of network connection (WiFi, cellular, etc.), whether the device is connected to the internet, and other related details.

What are @react-native-community/netinfo's main functionalities?

Check current network state

This feature allows you to fetch the current network state, including the connection type (e.g., WiFi, cellular) and whether the device is connected to the internet.

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

NetInfo.fetch().then(state => {
  console.log('Connection type', state.type);
  console.log('Is connected?', state.isConnected);
});

Subscribe to network state changes

This feature allows you to subscribe to network state changes, so you can react to changes in the network connection in real-time.

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

const unsubscribe = NetInfo.addEventListener(state => {
  console.log('Connection type', state.type);
  console.log('Is connected?', state.isConnected);
});

// Later, you can unsubscribe to stop listening for updates
unsubscribe();

Check if the device is connected to the internet

This feature allows you to check if the device is currently connected to the internet.

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

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

Get detailed network information

This feature provides detailed information about the network connection, including whether the internet is reachable and additional details specific to the connection type.

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

NetInfo.fetch().then(state => {
  console.log('Connection type', state.type);
  console.log('Is connected?', state.isConnected);
  console.log('Is internet reachable?', state.isInternetReachable);
  console.log('Details:', state.details);
});

Other packages similar to @react-native-community/netinfo

react-native-network-info

react-native-network-info is another React Native library that provides information about the device's network state. It offers functionalities such as getting the SSID of the connected WiFi network and the IP address of the device. However, it does not provide as comprehensive a set of features for monitoring network state changes as @react-native-community/netinfo.

react-native-connection-info

react-native-connection-info is a library that provides basic information about the network connection, such as the connection type and whether the device is connected to the internet. It is simpler and less feature-rich compared to @react-native-community/netinfo, making it suitable for applications that need only basic network information.

README

@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 using the instructions below (click on the arrow to show them):

Manually link the library on iOS

Either follow the instructions in the React Native documentation to manually link the framework or link using Cocoapods by adding this to your Podfile:

pod 'react-native-netinfo', path: '../node_modules/react-native-netinfo'

Manually link the library on Android

Make the following changes:

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.

Changelog

11.2.1 (2023-12-12)

Bug Fixes

• update internetReachability fetch abort (#706) (d44d5a8)