1.0.1 • Published 3 years ago

@gitgw/use-network v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

@gitgw/use-network

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

Installation

npm

npm i @gitgw/use-network

yarn

yarn add @gitgw/use-network

Usage

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

function App() {

  const onNetworkChange = ()=>{
    console.log("onNetworkChange");
  }

  const isOnline=useNetwork(onNetworkChange);

  return (
    <div className="App">
      <h1>{isOnline ? "Online" : "Offline"}</h1>
    </div>
  );
}

Arguments

ArgumentTypeDescriptionArgumentsRequired
onNetworkChangeFunctionFunction to be called when the network status changesisOnline : Booleanno

Return

Return valueTypeDescriptionDefault value
isOnlineBooleanA boolean representing if the user is online or nottrue