npm.io
3.4.0 • Published 5 months ago

cli-spinners

Licence
MIT
Version
3.4.0
Deps
0
Size
33 kB
Vulns
0
Weekly
0
Stars
2.9K

cli-spinners

70+ spinners for use in the terminal




The list of spinners is just a JSON file and can be used wherever.

You probably want to use one of these spinners through the ora package.

Install

npm install cli-spinners

Usage

import cliSpinners from 'cli-spinners';

console.log(cliSpinners.dots);
/*
{
	interval: 80,
	frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
}
*/
  • interval is the intended time per frame, in milliseconds.
  • frames is an array of frames to show for the spinner.

Preview

The header GIF is outdated. See live demo.

API

cliSpinners

Each spinner comes with a recommended interval and an array of frames.

See the spinners.

randomSpinner()

Get a random spinner.

import {randomSpinner} from 'cli-spinners';

console.log(randomSpinner());
/*
{
	interval: 80,
	frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
}
*/

Keywords