You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

49 lines
938 B
Markdown

5 years ago
# cli-spinners [![Build Status](https://travis-ci.org/sindresorhus/cli-spinners.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-spinners)
> 50+ spinners for use in the terminal
![](screenshot.gif)
The list of spinners is just a [JSON file](spinners.json) and can be used wherever.
You probably want to use one of these spinners through the [`ora`](https://github.com/sindresorhus/ora) module.
## Install
```
$ npm install --save cli-spinners
```
## Usage
```js
const cliSpinners = require('cli-spinners');
console.log(cliSpinners.dots);
/*
{
interval: 80,
frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
}
*/
```
## API
Each spinner comes with a recommended `interval` and an array of `frames`.
[See the spinners.](spinners.json)
## Related
- [ora](https://github.com/sindresorhus/ora) - Elegant terminal spinner
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)