1.0.2 • Published 5 years ago

react-latency v1.0.2

Weekly downloads
1
License
MIT
Repository
-
Last release
5 years ago

React Latency

A packaged version of the latency widget used by Jared Palmer in his Moving To React Suspense talk from React Conf 2018,

It's useful for mocking fetch requests at different latencies to observe how your app looks in various loading statees.

How To Use

The following examples are based around an app in it's default state when generated with create-react-app.

The package exports 3 named exports:

  • init - a function that should be called at some point in your application to instantiate the debugger widget
  • appWrapper - a HOC wrapper for your application/component
  • mockApiCall - a function to replace any fetch calls in your app that you wish to mock and add latency to

Import appWrapper and wrap the App component with it:

import React, { Component } from 'react';
import { appWrapper } from 'react-latency';

import logo from './logo.svg';
import './App.css';

class App extends Component {
  render() {
    return (
      <div className="App">
        <header className="App-header">
          <img src={logo} className="App-logo" alt="logo" />
          <p>
            Edit <code>src/App.js</code> and save to reload.
          </p>
          <a
            className="App-link"
            href="https://reactjs.org"
            target="_blank"
            rel="noopener noreferrer"
          >
            Learn React
          </a>
        </header>
      </div>
    );
  }
}

export default appWrapper(App);

Import mockApiCall and use it in place of a fetch call:

import React, { Component } from 'react';
import { appWrapper, mockAPICall } from 'react-latency';

import logo from './logo.svg';
import './App.css';

class App extends Component {
  async componentDidMount() {
    const result = await mockAPICall('/test', { hiphip: 'hooray' });
    console.log(result);
  }

  render() {
    return (
      <div className="App">
        <header className="App-header">
          <img src={logo} className="App-logo" alt="logo" />
          <p>
            Edit <code>src/App.js</code> and save to reload.
          </p>
          <a
            className="App-link"
            href="https://reactjs.org"
            target="_blank"
            rel="noopener noreferrer"
          >
            Learn React
          </a>
        </header>
      </div>
    );
  }
}

export default appWrapper(App);

Import init and invoke the function somewhere in your application, e.g. the index.js of your create-react-app application:

import React from 'react';
import ReactDOM from 'react-dom';
import { init } from 'react-latency';

import './index.css';
import App from './App';

import * as serviceWorker from './serviceWorker';

init();

ReactDOM.render(<App />, document.getElementById('root'));

// If you want your app to work offline and load faster, you can change
// unregister() to register() below. Note this comes with some pitfalls.
// Learn more about service workers: http://bit.ly/CRA-PWA
serviceWorker.unregister();

Credit

Thanks to Jared Palmer and Dan Abramov? for the code.