Detect Network Status in React native
Overview
In this article, we will learn how to detect the network status in React Native using a library called @react-native-community/netinfo. We will see how to install the library, how to get the network state once, how to subscribe and unsubscribe to network state updates, and how to make a React Native app to check and display the network status with code example. This article is intended for beginners in React Native who want to learn how to handle network connectivity in their apps.
Introduction
React Native is a popular framework for building cross-platform mobile apps using JavaScript and React. One of the challenges of developing mobile apps is dealing with network connectivity. Sometimes, the network may be unavailable, slow, or unstable, which can affect the user experience and functionality of the app. Therefore, it is important to detect the network status and react accordingly in our app.
To detect the network status in React Native, we can use a library called @react-native-community/netinfo. This library provides an API to access information about the device’s network state, such as whether it is connected, what type of connection it has (wifi, cellular, etc.), and other details. We can use this library to get the network state once or subscribe to network state updates and receive callbacks when the state changes.
Installation (@react-native-community/netinfo)
To use @react-native-community/netinfo in our React Native project, we need to install it using npm or yarn. We can run the following command in our project directory:
Manual Linking in iOS
- Open your project in Xcode and go to the project navigator.
- Right-click on the Libraries folder and select Add Files to [your project name].
- Navigate to node_modules/@react-native-community/netinfo/ios and select RNCNetInfo.xcodeproj.
- Click on Add.
- Go to your project’s Build Phases and expand the Link Binary With Libraries section.
- Click on the + button and select libRNCNetInfo.a from the list.
- Click on Add.
- Run your project.
Manual Linking in Android
- Open your project in Android Studio and go to the project view. Expand the android/app/src/main/java/[...]/MainApplication.java file and add the following import statement at the top:
- In the same file, find the getPackages() method and add the following line inside the List
:
- Expand the android/settings.gradle file and add the following lines at the end:
- Expand the android/app/build.gradle file and find the dependencies section. Add the following line inside the dependencies section:
- Run your project.
Get the Network State Once
To get the network state once in our app, we can use the fetch method from @react-native-community/netinfo. This method returns a promise that resolves to an object containing information about the network state. The object has the following properties:
type: The type of connection that is currently active. Possible values are: none, unknown, cellular, wifi, bluetooth, ethernet, wimax, vpn, or other. isConnected: A boolean value indicating whether the device is connected to a network or not. isInternetReachable: A boolean value indicating whether the device can access the internet or not. details: An object containing more details about the connection type. The properties of this object depend on the connection type. For example, for cellular connections, it may have properties like cellularGeneration, carrier, or isRoaming. We can use the fetch method as follows:
Subscribe and Unsubscribe to Network State Updates
To subscribe and unsubscribe to network state updates in our app, we can use the addEventListener and removeEventListener methods from @react-native-community/netinfo. These methods allow us to register and unregister callbacks that will be invoked whenever the network state changes.
The callback function receives an object containing information about the network state as a parameter. The object has the same properties as described in the previous section.
We can use these methods as follows:
Note that we need to store the return value of addEventListener() in a variable (in this case, unsubscribe) and call it when we want to unsubscribe from the updates. Alternatively, we can use a useEffect hook in our functional component to subscribe and unsubscribe automatically when the component mounts and unmounts.
Make a React Native App to Check and Display Network Status with Code Example
To demonstrate how to use @react-native-community/netinfo in a React Native app, we will make a simple app that checks and displays the network status on the screen. The app will have a text component that shows the connection type and a color indicator that shows whether the device is connected, internet reachable, or disconnected.
To make this app, we will use the following steps:
- Create a new React Native project using npx react-native init NetworkStatusApp.
- Install and link @react-native-community/netinfo using the instructions from the previous sections.
- Open the App.js file and import the necessary modules:
- Define some colors for the indicator:
- Define a functional component called NetworkStatus that will display the network status on the screen:
- Define some styles for the components:
- Render the NetworkStatus component in the App component:
-
Run the app on an emulator or a device and test the network status detection.
Conclusion
In this article, we learned how to:
- Detect network status in React Native using @react-native-community/netinfo.
- Install and link @react-native-community/netinfo in our project.
- Get the network state once using the fetch method.
- Subscribe and unsubscribe to network state updates using the addEventListener and removeEventListener methods.
- Make a React Native app to check and display network status with code example.
- We also learned some of the properties of the network state object, such as type, isConnected, isInternetReachable, and details.
I hope you enjoyed this article and learned something new. Thank you for reading!