Awesome 社区模块

chalk-animation

Build Status npm XO code style Code Climate

Colorful animations in terminal stdout

Available animations

Name Preview
rainbow rainbow
pulse rainbow
glitch rainbow
radar rainbow
neon rainbow

Install

1
$ npm install --save chalk-animation

Usage

1 2 3
const chalkAnimation = require('chalk-animation'); chalkAnimation.rainbow('Lorem ipsum dolor sit amet');

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

1 2 3 4 5 6 7 8 9
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

1 2 3 4 5
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.

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

Change the animated text seamlessly with replace()

1 2 3 4 5 6 7 8
let str = 'Loading...'; const rainbow = chalkAnimation.rainbow(str); // Add a new dot every second setInterval(() => { str += '.'; rainbow.replace(str); }, 1000);

CLI mode

1 2
# Install package globally $ npm install --global chalk-animation
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$ chalk-animation --help Usage $ chalk-animation <name> [text...] Available animations rainbow pulse glitch radar neon Example $ chalk-animation rainbow Hello world!

License

MIT © Boris K