Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emanuelescarabattoli/react-network-status-hook

A simple React Hook to check if browser is online or offline
https://github.com/emanuelescarabattoli/react-network-status-hook

hook network offline online reactjs status

Last synced: 10 days ago
JSON representation

A simple React Hook to check if browser is online or offline

Awesome Lists containing this project

README

        

# React Network Status Hook

A simple React Hook to check if browser is online or offline.

# Installation

To install the package run the following command.

```
npm install react-network-status-hook
```

# Usage with default parameters

Just import the Hook and use it to detect offline or online status.
The check will be done by send a request every `500` milliseconds to `https://dns.google/` but you can change parameters as described in the next section.

```
import React from "react";
import useNetworkStatus from "react-network-status-hook";

const MyComponent = () => {
const isOnline = useNetworkStatus();

return (
isOnline ? Online : Offline
)
};
```

# Usage with custom parameters

You can specify custom parameters for the check as shown here.

```
import React from "react";
import useNetworkStatus from "react-network-status-hook";

const MyComponent = () => {
const isOnline = useNetworkStatus("http://localhost:8000/", 1000);

return (
isOnline ? Online : Offline
)
};
```