Package Exports

loading-indicator
loading-indicator/presets

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (loading-indicator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

loading-indicator

Simple and customizable command line loading indicator

Install

Warning: v2.0.0 is a complete rewrite of the previous implementation.

$ npm install loading-indicator --save

Usage

import loading from 'loading-indicator';

// Initialize the loading animation and saves the timer id
const timer = loading.start();

// 1500ms later, stop the loading animation passing along the timer id
setTimeout(() => {
  loading.stop(timer);
}, 1500);

demo-default

Presets

import loading from 'loading-indicator';
// Import available presets
import presets from 'loading-indicator/presets';

// Use an available preset (or simply provides an array with your custom preset)
const timer = loading.start(null, {
  frames: presets.arrows
});

demo-presets

Custom text

import loading from 'loading-indicator';

// Setup a custom loading text
const timer = loading.start('Loading...');

demo-custom-text

API

`loading.start([text], [options])`

Returns a number with the id that is used to reset the render interval (later referenced as timer).

`text`

Type: string
Default: null

Text do append to the indicator symbol.

`options`

Type: object

Available options.

`options.delay`

Type: number (milliseconds)
Default: 100

Delay for the render to be triggered.

`options.frames`

Type: array
Default: presets.spinner

Frames for the loading animation sequence.

Available presets are:

`loading.stop(timer, [shouldKeepOutput])`

`timer`

Required
Type: number (integer)

Id of the render function interval.

`shouldKeepOutput`

Type: boolean
Default: false

Whether or not to keep the output when loading.stop() is called.