Giter Club home page Giter Club logo

react-network's Introduction

React Network

logo

What?

Notifies your app when the network connection goes online or offline.

Why?

Because the next billion users of the internet will have a decent device but a spotty connection. Having a component to help you declarative deal with that is super fantastic.

Installation

npm install react-network
# or
yarn add react-network

And then import it:

// using es modules
import Network from 'react-network'

// common.js
const Network = require('react-network').default

// AMD
// I've forgotten but it should work.

Or use script tags and globals.

<script src="https://unpkg.com/react-network"></script>

And then grab it off the global like so:

const Network = ReactNetwork.default

How?

// import Network from 'react-network'
const Network = ReactNetwork.default

ReactDOM.render((
  <Network
    onChange={({ online }) => {
      if (online && window.cornify_add) {
        window.cornify_add()
      }
    }}
    render={({ online }) =>
      <div style={{ textAlign: 'center' }}>
        <p>Every time you go back online, a unicorn is born!</p>
        <p>
          You can open up the devtools to simulate losing the
          network, or actually turn off your wifi to see these demos.
        </p>
        <h1>
          {online
            ? "You are online."
            : "You are at a hotel."
          }
        </h1>
      </div>
    }
  />
), DOM_NODE)

Props

render

Whatever you'd like to render in response to changes in the network.

// import Network from 'react-network'
const Network = ReactNetwork.default
ReactDOM.render((
  <Network render={({ online }) =>
    <p>You are online: {online ? 'Yep' : 'Nope'}.</p>
  }/>
), DOM_NODE)

onChange

Called whenever the network goes on or offline. This is useful to fire off some imperative code, like adding unicorns to the page or more practically, avoiding resource fetching until the network comes back online.

// import Network from 'react-network'
const Network = ReactNetwork.default

class App extends React.Component {
  state = {
    image: null
  }

  handleNetworkChange = ({ online }) => {
    if (online) {
      this.fetch()
    } else {
      clearTimeout(this.timeout)
    }
  }

  fetch = () => {
    fetch('https://unsplash.it/640/400/?random')
      .then(res => res.blob())
      .then(blob => {
        var image = URL.createObjectURL(blob)
        this.setState({ image })
        this.timeout = setTimeout(this.fetch, 5000)
      })
  }

  render() {
    return (
      <div style={{ position: 'relative' }}>
        {this.state.image ? (
          <img src={this.state.image} width="100%"/>
        ) : (
          <p>Loading first image</p>
        )}
        <Network
          onChange={this.handleNetworkChange}
          render={({ online }) => (
            online ? null : (
              <p style={{ color: 'red' }}>
                You are offline, images will continue when you get back online.
              </p>
            )
          )}
        />
      </div>
    )
  }
}

ReactDOM.render(<App/>, DOM_NODE)

Legal

Released under MIT license.

Copyright © 2017-present React Training LLC

react-network's People

Contributors

redonkulus avatar ryanflorence avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.