npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-online-hook

v1.0.4

Published

React hook to monitor network status.

Downloads

103

Readme

React online hook

npm npm bundle minified size npm type definitions Snyk Vulnerabilities for GitHub Repo tested with jest Cypress.io License: MIT

Lightweight, easy to use React hook to detect if user is online or offline with TypeScript / Flow support & progressive enhancement capabilities.

Use cases

  • Offline banners/warnings
  • Online status indicators
  • Offline-aware form submissions
  • Offline-aware network actions
  • Component-level offline handling

Installation

Using npm:

npm install react-online-hook

Using yarn:

yarn add react-online-hook

Usage

useOnlineStatus monitors whether the user is online or offline & returns an up to date status.

Here is an example of how it could be used:

import React from 'react';
import useOnlineStatus from 'react-online-hook';
// or
const useOnlineStatus = require('react-online-hook');

const OnlineIndicator = () => {
    const { isOnline } = useOnlineStatus();

    return (
        <span>
            { isOnline ? 'Online' : 'Offline' }
        </span>
    );
};

export default OnlineIndicator;

Demo

You can play with demo application built to show how useOnlineStatus works using network tab in developer tools.

how-to-play-demo.png

Please note that if you use any modern browser, isAssumedStatus will alway be false.

Callback on status change

If you want to perform an action when online status changes, you can use useEffect specifying isOnline in the dependency array like this:

import React, {useEffect} from 'react';
import useOnlineStatus from 'react-online-hook';

const OnlineIndicator = () => {
    const { isOnline } = useOnlineStatus();

    useEffect(() => {
        if (isOnline) {
            alert('You are online! 🚀');
        } else {
            alert('You are offline 😿');
        }
    }, [isOnline]);

    return (
        <span>
            { isOnline ? 'Online' : 'Offline' }
        </span>
    );
};

export default OnlineIndicator;

Progressive enhancement

Internally useOnlineStatus uses window.navigator.onLine to get initial status when you first call it. According to Can I use, this property is supported by around 98% of the browsers.

If your project supports legacy browsers, you could use a utility provided by useOnlineStatus to easily implement progressive enhancement.

useOnlineStatus is aware that window.navigator.onLine might not be present. In that case, it assumes that when it first called (which happens on initial mount of your component), the browser is online.

useOnlineStatus indicates when the status is assumed & you could use this information like this to implement progressive enhancement:

import React from 'react';
import useOnlineStatus from 'react-online-hook';

const LegacyBrowserOnlineIndicator = () => {
    const { isOnline, isAssumedStatus } = useOnlineStatus();

    if (isAssumedStatus) {
        return null;
    }

    return (
        <span>
            { isOnline ? 'Online' : 'Offline' }
        </span>
    );
};

export default LegacyBrowserOnlineIndicator;

Additional things to consider:

  • When status is assumed, isOnline is true. You could just use this assumption if it is reasonable in your case.

  • isAssumedStatus might change to false if browser does not have window.navigator.onLine but correctly dispatches online or offline events.

  • useOnlineStatus internally uses addEventListener & removeEventListener.

License

This project is licensed under the terms of the MIT license.