@practical-react-hooks/use-network

1.0.0 • Public • Published

@practical-react-hooks/use-network

React Hook to listen when the user goes online or offline.

Installation

yarn

yarn add @practical-react-hooks/use-network

npm

npm i @practical-react-hooks/use-network

Usage

import React from "react";
import useNetwork from "@practical-react-hooks/use-network";

const App = () => {
  const onNetworkChange = isOnline => console.log(isOnline ? "We are back online" : "We just got offline");
  const isOnline = useNetwork(onNetworkChange);
  return (
    <div className="App">
      <h1>{isOnline ? "We are online" : "We are offline"}</h1>
    </div>
  );
};

Arguments

Argument Type Description Arguments Required
onNetworkChange function Function to be called when the network status changes isOnline : Boolean no

Return

Return value Type Description Default value
isOnline Boolean A boolean representing if the user is online or not true

Readme

Keywords

Package Sidebar

Install

npm i @practical-react-hooks/use-network

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

2.62 kB

Total Files

4

Last publish

Collaborators

  • octo908