# chalk-animation > Colorful animations in terminal output Latest version **2.0.3** (published 2022-09-06) · MIT license · 0 weekly downloads ## Install ```sh npm install chalk-animation pnpm add chalk-animation yarn add chalk-animation bun add chalk-animation ``` Provides the command `chalk-animation`. ## Health **Score 18/100 (F)** — status: abandoned. Positive: has types package; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score; declining downloads. ## Facts | | | |---|---| | Version | 2.0.3 | | Published | 2022-09-06 | | First published | 2017-07-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | separate (@types/chalk-animation) | | Module format | ESM + CommonJS | | Node | >=12 | | Dependencies | 3 | | Unpacked size | 12.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2182 | | Author | Boris K | | Maintainers | bokub | | Keywords | animation, chalk, cli, color, colors, colour, command-line, console, formatting, gradient, log, logging, rainbow, shell, string, style, styles, terminal | ## Links - npm: https://www.npmjs.com/package/chalk-animation - Repository: https://github.com/bokub/chalk-animation - Issues: https://github.com/bokub/chalk-animation/issues - npm.io page: https://npm.io/package/chalk-animation ## Dependencies (3) - [meow](https://npm.io/package/meow.md) ^10.1.2 - [chalk](https://npm.io/package/chalk.md) ^4.1.2 - [gradient-string](https://npm.io/package/gradient-string.md) ^2.0.2 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 2.0.3 (latest) — 2022-09-06 - 2.0.2 — 2022-04-19 - 2.0.1 — 2022-04-19 - 2.0.0 — 2022-04-19 - 1.6.0 — 2018-04-07 - 1.5.2 — 2018-03-31 - 1.5.1 — 2018-03-27 - 1.5.0 — 2018-03-13 - 1.4.0 — 2018-01-01 - 1.3.0 — 2017-10-05 - 1.2.0 — 2017-08-21 - 1.1.1 — 2017-08-07 - 1.1.0 — 2017-08-01 - 1.0.0 — 2017-07-31 - 0.3.0 — 2017-07-27 - … 3 more at https://npm.io/package/chalk-animation/versions ## README # chalk-animation [![Build Status](https://flat.badgen.net/github/checks/bokub/chalk-animation?label=tests)](https://github.com/bokub/chalk-animation/actions/workflows/run.yml) [![Version](https://runkit.io/bokub/npm-version/branches/master/chalk-animation?style=flat)](https://www.npmjs.com/package/chalk-animation) [![Codecov](https://flat.badgen.net/codecov/c/github/bokub/chalk-animation)](https://codecov.io/gh/bokub/chalk-animation) [![Downloads](https://flat.badgen.net/npm/dm/chalk-animation?color=FF9800)](https://www.npmjs.com/package/chalk-animation) [![XO code style](https://flat.badgen.net/badge/code%20style/XO/5ed9c7)](https://github.com/sindresorhus/xo) > Colorful animations in terminal output ## Available animations | Name | Preview | |:---------:|:------------------------------------------:| | rainbow | ![rainbow](http://i.imgur.com/napdxdn.gif) | | pulse | ![pulse](http://i.imgur.com/xdaETwr.gif) | | glitch | ![glitch](http://i.imgur.com/834FJU1.gif) | | radar | ![radar](http://i.imgur.com/3bFrtRc.gif) | | neon | ![neon](http://i.imgur.com/YdAAroI.gif) | | karaoke | ![karaoke](https://i.imgur.com/lG7EF1t.gif)| ## Install ```bash $ npm i chalk-animation ``` ## Usage ```javascript import chalkAnimation from 'chalk-animation'; chalkAnimation.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**. ```javascript const rainbow = chalkAnimation.rainbow('Lorem ipsum'); // Animation starts setTimeout(() => { rainbow.stop(); // Animation stops }, 1000); setTimeout(() => { rainbow.start(); // Animation resumes }, 2000); ``` #### Automatic stop Anything printed to the console will stop the previous animation automatically ```javascript chalkAnimation.rainbow('Lorem ipsum'); setTimeout(() => { // Stop the 'Lorem ipsum' animation, then write on a new line. console.log('dolor sit amet'); }, 1000); ``` #### Changing speed Change the animation speed using a second parameter. Should be greater than 0, default is 1. ```javascript chalkAnimation.rainbow('Lorem ipsum', 2); // Two times faster than default ``` #### Changing text Change the animated text seamlessly with `replace()` ```javascript let str = 'Loading...'; const rainbow = chalkAnimation.rainbow(str); // Add a new dot every second setInterval(() => { rainbow.replace(str += '.'); }, 1000); ``` #### Manual rendering Manually render frames with `render()`, or get the content of the next frame with `frame()` ```javascript 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); ``` ## CLI mode ```bash # Install package globally $ npm install --global chalk-animation ``` ``` $ chalk-animation --help Colorful animations in terminal output Usage $ chalk-animation [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! ``` ## Related - [gradient-string](https://github.com/bokub/gradient-string) - Output gradients to terminal - [chalk](https://github.com/chalk/chalk) - Output colored text to terminal ## License MIT © [Boris K](https://github.com/bokub) --- _Source: https://npm.io/package/chalk-animation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._