chalk-animation

Colorful animations in terminal output

Available animations

Name	Preview
rainbow
pulse
glitch
radar
neon
karaoke

Install

1$ npm i @figliolia/chalk-animation

Usage

1import { ChalkAnimation } from '@figliolia/chalk-animation';
2
3ChalkAnimation.rainbow('Lorem ipsum dolor sit amet');

Start and stop

You can stop and resume an animation with stop() and start().

When created, the instance of ChalkAnimation starts automatically.

1const rainbow = ChalkAnimation.rainbow('Lorem ipsum'); // Animation starts
2
3setTimeout(() => {
4    rainbow.stop(); // Animation stops
5}, 1000);
6
7setTimeout(() => {
8    rainbow.start(); // Animation resumes
9}, 2000);
10

Automatic stop

Anything printed to the console will stop the previous animation automatically

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

Changing speed

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

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

Changing text

Change the animated text seamlessly with replace()

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

Manual rendering

Manually render frames with render(), or get the content of the next frame with frame()

1const rainbow = ChalkAnimation.rainbow('Lorem ipsum').stop(); // Don't start the animation
2
3rainbow.render(); // Display the first frame
4
5const frame = rainbow.frame(); // Get the second frame
6console.log(frame);

License

MIT © Alex Figliolia