use-spinner

use-spinner

Add a simple loading spinner to your async JS calls - built for the browser.

Installation

$ npm install --save use-spinner

Usage

import useSpinner from 'use-spinner';

import 'use-spinner/assets/use-spinner.css';

const fn = async () => {
  await new Promise(resolve => setTimeout(() => {
    console.log('done.');
    resolve();
  }, 2000));
};

// wrap your asynchronous function
const spinnedFn = useSpinner(fn, {
  container: 'body'
});

// execute with a loading spinner
await spinnedFn();

Options

The API accepts a second argument configuring the wrapped function. This defaults to:

{
  container: 'body'
}

• container: a selector or a DOM element that appends the loading spinner.

License

MIT

Changelog

0.2.0

• FEAT: allow defining container as DOM element (4e077793)
• CHORE: add basic API docs (a01211df)
• CHORE: minify distro via terser (8f69b18e)
• CHORE: add basic testing infrastructure (72926d09)