chalk-animation

chalk-animation

Colorful animations in terminal stdout

Available animations

Name	Preview
rainbow
pulse
glitch
radar
neon

Install

$ npm install --save chalk-animation

Usage

const chalkAnimation = require('chalk-animation');

chalkAnimation.rainbow('Lorem ipsum dolor sit amet');

You can stop and restart an animation with stop() and start()

const rainbow = chalkAnimation.rainbow('Lorem ipsum'); // Animation starts

setTimeout(() => {
    rainbow.stop(); // Animation stops
}, 1000);

setTimeout(() => {
    rainbow.start(); // Animation resumes
}, 2000);

Anything printed to the console will stop the previous animation automatically

chalkAnimation.rainbow('Lorem ipsum');
setTimeout(() => {
    // Stop the 'Lorem ipsum' animation, then write on a new line.
    console.log('dolor sit amet');
}, 1000);

Change the animation speed using a second parameter. Should be greater than 0, default is 1.

chalkAnimation.rainbow('Lorem ipsum', 2); // Two times faster than default

Change the animated text seamlessly with replace()

let str = 'Loading...';
const rainbow = chalkAnimation.rainbow(str);

// Add a new dot every second
setInterval(() => {
	str += '.';
	rainbow.replace(str);
}, 1000);

CLI mode

# Install package globally
$ npm install --global chalk-animation

$ chalk-animation --help

Usage
  $ chalk-animation <name> [text...]

Available animations
  rainbow
  pulse
  glitch
  radar
  neon

Example
  $ chalk-animation rainbow Hello world!

Related

• gradient-string - Output gradients to terminal
• chalk - Output colored text to terminal

License

MIT © Boris K