# elegant-spinner

> Elegant spinner for interactive CLI apps

Latest version **3.0.0** (published 2021-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install elegant-spinner
pnpm add elegant-spinner
yarn add elegant-spinner
bun add elegant-spinner
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-09-07 |
| First published | 2015-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/elegant-spinner) |
| Module format | ESM |
| Node | ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 |
| Dependencies | 0 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 225 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | ansi, terminal, console, cli, string, log, logging, spinner, busy, indicator, loading, loader, progress, elegant, loiter, interactive |

## Links

- npm: https://www.npmjs.com/package/elegant-spinner
- Repository: https://github.com/sindresorhus/elegant-spinner
- Homepage: https://github.com/sindresorhus/elegant-spinner#readme
- Issues: https://github.com/sindresorhus/elegant-spinner/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/elegant-spinner

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 3.0.0 (latest) — 2021-09-07
- 2.0.0 — 2019-04-12
- 1.0.1 — 2015-10-02
- 1.0.0 — 2015-08-16

## README

# elegant-spinner

> Elegant spinner for interactive CLI apps

<img width="173" src="screenshot.gif">

**You probably want [`ora`](https://github.com/sindresorhus/ora) instead, which includes this spinner and handles the animation for you.**

## Install

```
$ npm install elegant-spinner
```

## Usage

```js
import elegantSpinner from 'elegant-spinner';
import logUpdate from 'log-update';

const frame = elegantSpinner();

setInterval(() => {
	logUpdate(frame());
}, 50);
```

## Related

- [log-update](https://github.com/sindresorhus/log-update) - Log by overwriting the previous output in the terminal. Useful for rendering progress bars, animations, etc.

---

<div align="center">
	<b>
		<a href="https://tidelift.com/subscription/pkg/npm-elegant-spinner?utm_source=npm-elegant-spinner&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
	</b>
	<br>
	<sub>
		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
	</sub>
</div>

---
_Source: https://npm.io/package/elegant-spinner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._