The 'spinnies' npm package is a utility for managing multiple CLI spinners. It allows you to create, update, and stop multiple spinners simultaneously, which is useful for providing visual feedback in command-line applications.
Creating and Adding Spinners
This feature allows you to create and add a new spinner with a specific text. The spinner can be identified by a unique key, in this case, 'spinner1'.
const Spinnies = require('spinnies');
const spinnies = new Spinnies();
spinnies.add('spinner1', { text: 'Loading...' });Updating Spinners
This feature allows you to update the text and status of an existing spinner. The spinner is identified by its key, and you can change its text and status.
spinnies.update('spinner1', { text: 'Still loading...', status: 'spinning' });Succeeding and Failing Spinners
This feature allows you to mark a spinner as succeeded or failed. You can provide a final text message to indicate the outcome.
spinnies.succeed('spinner1', { text: 'Loaded successfully!' });
spinnies.fail('spinner2', { text: 'Failed to load.' });Removing Spinners
This feature allows you to remove a spinner from the list of active spinners. The spinner is identified by its key.
spinnies.remove('spinner1');Ora is a lightweight CLI spinner with support for multiple spinners. It provides similar functionality to spinnies but is more focused on single spinner instances. Ora is simpler to use for single tasks but lacks the built-in management of multiple spinners that spinnies offers.
Cli-spinners is a collection of various spinner animations for use in the terminal. While it does not manage spinners directly, it provides a variety of spinner styles that can be used with other spinner management libraries like spinnies or ora.
Listr is a library for creating elegant CLI task lists with progress spinners. It is more task-oriented and provides a higher-level abstraction for managing tasks and their statuses, including spinners. It is more feature-rich compared to spinnies but also more complex.
Spinnies Node.js module to create and manage multiple spinners in command-line interface programs
$ npm i spinnies
const spinnies = new Spinnies();
spinnies.add('spinner-1', { text: 'I am a spinner' });
spinnies.add('spinner-2', { text: 'I am another spinner' });
setTimeout(() => {
spinnies.succeed('spinner-1', { text: 'Success!' });
spinnies.fail('spinner-2', { text: 'Fail :(' });
}, 2000);
This library follows a non-error-throwing philosophy. If you provide an invalid option or an invalid value for a valid option it will be ignored.
Parameters
object:
color - string: Any valid chalk color. The default value is white.
succeedColor - string: Any valid chalk color. The default value is green.
failColor - string: Any valid chalk color. The default value is red.
spinnerColor - string: Any valid chalk color. The default value is greenBright.
succeedPrefix - string: The default value is ✓.
failPrefix- string: The default value is ✖.
spinner- object:
numberstring[]You can see the already provided spinner here.
disableSpins - boolean: Disable spins (will still print raw messages).
Note: If you are working in any win32 platform, the default spin animation will be overriden. You can get rid of this defining a different spinner animation manually, or by using the integrated VSCode terminal or Windows Terminal.
Example:
const spinner = { interval: 80, frames: ['🍇', '🍈', '🍉', '🍋'] }
const spinnies = new Spinnies({ color: 'blue', succeedColor: 'green', spinner });
Adds a new spinner with the given name.
Parameters:
string: spinner reference name.object:
string: Optional text to show in the spinner. If none is provided, the name field will be shown.number: Optional, indent the spinner with the given number of spaces.string: Initial status of the spinner. Valid statuses are: succeed, fail, spinning, non-spinnableand stopped.string: Any valid chalk color.string: Any valid chalk color.string: Any valid chalk color.Return value: Returns the spinner's options.
Example:
const spinnies = new Spinnies();
spinnies.add('spinner-1');
spinnies.add('another-spinner', { text: 'Hello, I am a spinner!', color: 'greenBright' });
Picks a spinner.
Parameters:
string: spinner reference name.Return value: Returns the spinner's options.
Removes a spinner.
Parameters:
string: spinner reference name.Return value: Returns the spinner's options.
Updates the spinner with name name with the provided options.
Parameters:
string: spinner reference name.object:
string: Optional text to show in the spinner. If none is provided, the name field will be shown.string: New status of the spinner. Valid statuses are: succeed, fail, spinning, non-spinnableand stopped.string: Any valid chalk color.string: Any valid chalk color.string: Any valid chalk color.Return value: Returns the spinner's options.
Example:
const spinnies = new Spinnies();
spinnies.add('spinner-1', { text: 'Hello! I am the initial text', color: 'green' });
// some code
spinnies.update('spinner-1', { text: 'Hello, I am an updated text!', color: 'blue' });
Sets the specified spinner status as succeed.
Parameters:
string: spinner reference name.object:
string: Optional text to show in the spinner. If none is provided, the name field will be shown.string: Any valid chalk color.Return value: Returns the spinner's options.
Example:
const spinnies = new Spinnies();
spinnies.add('spinner-1', { text: 'Hello! I am the initial text', color: 'green' });
// some code
spinnies.succeed('spinner-1', { text: 'Success!', successColor: 'greenBright' });
Sets the specified spinner status as fail.
Parameters:
string: spinner reference name.object:
string: Optional text to show in the spinner. If none is provided, the name field will be shown.string: Any valid chalk color.Return value: Returns the spinner's options.
Example:
const spinnies = new Spinnies();
spinnies.add('spinner-1', { text: 'Hello! I am the initial text', color: 'green' });
// some code
spinnies.fail('spinner-1', { text: 'I failed', failColor: 'redBright' });
Stops the spinners and sets the non-succeeded and non-failed ones to the provided status, which can be succeed, fail or stopped. You can see an example here.
Return value: returns false if all spinners have succeeded, failed or have been stopped.
Star it, fork it, improve it, PR it! :raised_hands:.
Thanks to chalk for helping making this lib colorful :rainbow: and to ora which was a great inspiration :unicorn:.
FAQs
Create and manage multiple spinners in command-line interface programs
The npm package spinnies receives a total of 99,853 weekly downloads. As such, spinnies popularity was classified as popular.
We found that spinnies demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.