Module communautaire génial

craie-animation

État de la construction npm Codecov npm Style de code XO

Animations colorées dans la sortie du terminal

Animations disponibles

Nom Aperçu
arc-en-ciel arc-en-ciel
impulsion impulsion
problème problème
radar radar
néon néon
karaoké karaoké

Installer

1
$ npm i chalk-animation

Usage

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

Démarrer et arrêter

Vous pouvez arrêter et reprendre une animation avec stop()et start().

Une fois créée, l'instance de craieAnimation démarre automatiquement .

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

Arrêt automatique

Tout ce qui est imprimé sur la console arrêtera automatiquement l'animation précédente

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);

Changement de vitesse

Modifiez la vitesse d'animation à l'aide d'un deuxième paramètre. Doit être supérieur à 0, la valeur par défaut est 1.

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

Changer de texte

Modifiez le texte animé en toute transparence avec replace()

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

Rendu manuel

Rendre manuellement les images avec render(), ou obtenir le contenu de l'image suivante avecframe()

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

Mode CLI

1 2
# Install package globally $ npm install --global chalk-animation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
$ chalk-animation --help Colorful animations in terminal output Usage $ chalk-animation <name> [options] [text...] Options --duration Duration of the animation in ms, defaults to Infinity --speed Animation speed as number > 0, defaults to 1 Available animations rainbow pulse glitch radar neon karaoke Example $ chalk-animation rainbow Hello world!

Licence

MIT © Boris K