1 | # cli-spinners [![Build Status](https://travis-ci.org/sindresorhus/cli-spinners.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-spinners)
|
2 |
|
3 | > 50+ spinners for use in the terminal
|
4 |
|
5 | ![](screenshot.gif)
|
6 |
|
7 | The list of spinners is just a [JSON file](spinners.json) and can be used wherever.
|
8 |
|
9 | You probably want to use one of these spinners through the [`ora`](https://github.com/sindresorhus/ora) module.
|
10 |
|
11 |
|
12 | ## Install
|
13 |
|
14 | ```
|
15 | $ npm install --save cli-spinners
|
16 | ```
|
17 |
|
18 |
|
19 | ## Usage
|
20 |
|
21 | ```js
|
22 | const cliSpinners = require('cli-spinners');
|
23 |
|
24 | console.log(cliSpinners.dots);
|
25 | /*
|
26 | {
|
27 | interval: 80,
|
28 | frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
|
29 | }
|
30 | */
|
31 | ```
|
32 |
|
33 |
|
34 | ## API
|
35 |
|
36 | Each spinner comes with a recommended `interval` and an array of `frames`.
|
37 |
|
38 | [See the spinners.](spinners.json)
|
39 |
|
40 |
|
41 | ## Related
|
42 |
|
43 | - [ora](https://github.com/sindresorhus/ora) - Elegant terminal spinner
|
44 |
|
45 |
|
46 | ## License
|
47 |
|
48 | MIT © [Sindre Sorhus](https://sindresorhus.com)
|