elegant-spinner

What is elegant-spinner?

The elegant-spinner npm package provides a simple, elegant spinner for use in command-line interface (CLI) applications. It is designed to show a loading or processing indicator in a minimalistic and visually appealing way. This can enhance the user experience in CLI applications by providing feedback that a process is ongoing.

What are elegant-spinner's main functionalities?

Creating a spinner instance

This code sample demonstrates how to create a spinner instance using the elegant-spinner package. It uses the `createSpinner` function to initialize the spinner and then sets an interval to update the spinner animation in the terminal.

const createSpinner = require('elegant-spinner');
const frame = createSpinner();
setInterval(() => {
  process.stdout.write('\r' + frame());
}, 50);

Other packages similar to elegant-spinner

ora

Ora is a popular npm package that provides more customizable spinners for CLI applications. It offers a wide range of spinner styles, color options, and the ability to add text alongside the spinner. Compared to elegant-spinner, ora provides more features and customization options, making it suitable for more complex CLI applications.

cli-spinners

cli-spinners is a collection of spinners for use in the command line, offering a wide variety of designs. Unlike elegant-spinner, which provides a single, elegant spinner design, cli-spinners offers a large selection of spinner styles to choose from, allowing developers to select one that best fits their application's aesthetic.

spinner

The spinner package is another alternative that provides basic spinner functionality for CLI applications. It is similar to elegant-spinner in its simplicity and ease of use but offers fewer customization options. It's a good choice for applications that require a straightforward, no-frills loading indicator.

README

elegant-spinner

Elegant spinner for interactive CLI apps

You probably want ora instead, which includes this spinner and handles the animation for you.

Install

$ npm install elegant-spinner

Usage

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

const frame = elegantSpinner();

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

Related

• log-update - Log by overwriting the previous output in the terminal. Useful for rendering progress bars, animations, etc.

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}