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

@oieduardorabelo/use-navigator-online

v6.2.2

Published

React Hooks to detect when your browser is online/offline.

Downloads

2,173

Readme

@oieduardorabelo/use-navigator-online

React Hooks to detect when your browser is online/offline using window.navigator.onLine API.

To install it:

yarn add @oieduardorabelo/use-navigator-online

Example

An online demo is available at CodeSandbox:

  • Live demo: https://codesandbox.io/s/live-demo-use-navigator-online-1xy56

If you've any issues, open an issue with a CodeSandbox link with your issue

API Explained

In your app, you can add:

import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';

function App() {
  let details = useNavigatorOnline(options)
  ...
}

details object is composed of:

  • details.isOnline: It is a Boolean value, true when online
  • details.isOffline: It is a Boolean value, true when offline
  • details.status: Returns a default String, when online it is "online" and when offline it is "offline". You can customize it using options param

options object is composed of:

  • options.whenOnline: Can be any valid React children. It will replace the String returned in details.status when online.
  • options.whenOffline: Can be any valid React children. It will replace the String returned in details.status when offline.
  • options.startOnline: To support SSR, you can control the initial rendering mode using this option. It is a boolean value to determine which state your application should use first: true for "online-first" or false for "offline-first". Defaults to true/online-first. The value will be synced with window.navigator.onLine inside an useEffect when your application is rendered in the browser.

Examples

Using isOnline and isOffline flags:

import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';

function App() {
  let { isOnline, isOffline } = useNavigatorOnline();

  return (
    <div>
      {isOnline && <span>We are online!</span>}
      {isOffline && <span>We are offline!</span>}
    </div>
  );
}

Using default status:

import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';

function App() {
  // will toggle between "online" and "offline"
  let { status } = useNavigatorOnline();

  return <div>Browser now is {status}!</div>;
}

Custom values for status with whenOnline and whenOffline:

import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';

function App() {
  // you can pass any React children in "whenOnline" and "whenOffline"
  let { status } = useNavigatorOnline({
    whenOnline: <h1>WE ARE ONLINE!</h1>,
    whenOffline: <h4>Damn, offline :(</h4>,
  });

  return <div>{status}</div>;
}

No extra configuration is needed to use it on SSR:

import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';

function App() {
  let { status } = useNavigatorOnline();

  return <div>{status}</div>;
}

You can initialize your application offline-first. This will sync with window.navigator.onLine when your application starts, using a useEffect. Trigerring a re-render of your application.

import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';

function App() {
  let { status } = useNavigatorOnline({
    startOnline: false
  });

  return <div>{status}</div>;
}

License

MIT License © Eduardo Rabelo