@gitgw/use-network

1.0.1 • Public • Published

@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

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

/@gitgw/use-network/

    Package Sidebar

    Install

    npm i @gitgw/use-network

    Weekly Downloads

    0

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    2.25 kB

    Total Files

    4

    Last publish

    Collaborators

    • githubgw