1.0.1 • Published 9 months ago

@smooks/use-network v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

@smooks/use-network

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

Installation

yarn

yarn add @smooks/use-network

npm

npm i @smooks/use-network

Usage

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

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

Argument

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
1.0.1

9 months ago

1.0.0

9 months ago