# colorette > 🌈Easily set your terminal text color & styles. Latest version **2.0.20** (published 2023-04-16) Β· MIT license Β· 0 weekly downloads ## Install ```sh npm install colorette pnpm add colorette yarn add colorette bun add colorette ``` ## Health **Score 40/100 (D)** β€” status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned. ## Facts | | | |---|---| | Version | 2.0.20 | | Published | 2023-04-16 | | First published | 2018-08-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 16.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1623 | | Author | Jorge Bucaran | | Maintainers | jorgebucaran | | Keywords | terminal, styles, color, ansi | ## Links - npm: https://www.npmjs.com/package/colorette - Repository: https://github.com/jorgebucaran/colorette - Homepage: https://github.com/jorgebucaran/colorette#readme - Issues: https://github.com/jorgebucaran/colorette/issues - npm.io page: https://npm.io/package/colorette ## Alternatives - [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) β€” 6.4M weekly downloads - [randomcolor](https://npm.io/package/randomcolor.md) β€” 348.0K weekly downloads - [bows](https://npm.io/package/bows.md) β€” 1.3K weekly downloads - [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) β€” 260 weekly downloads - [coc-yank](https://npm.io/package/coc-yank.md) β€” 61 weekly downloads ## Recent versions - 2.0.20 (latest) β€” 2023-04-16 - 2.0.19 β€” 2022-06-14 - 2.0.18 β€” 2022-06-14 - 2.0.17 β€” 2022-06-03 - 2.0.16 β€” 2021-10-08 - 2.0.15 β€” 2021-10-07 - 2.0.14 β€” 2021-10-03 - 2.0.13 β€” 2021-10-01 - 2.0.12 β€” 2021-09-26 - 2.0.11 β€” 2021-09-25 - 2.0.10 β€” 2021-09-24 - 2.0.9 β€” 2021-09-24 - 2.0.8 β€” 2021-09-23 - 2.0.7 β€” 2021-09-22 - 2.0.6 β€” 2021-09-22 - … 22 more at https://npm.io/package/colorette/versions ## README # 🌈Colorette > Easily set your terminal text color & styles. - No dependecies - Automatic color support detection - Up to [2x faster](#benchmarks) than alternatives - TypeScript support - [`NO_COLOR`](https://no-color.org) friendly - Node >= `10` > [**Upgrading from Colorette `1.x`?**](https://github.com/jorgebucaran/colorette/issues/70) ## Quickstart ```js import { blue, bold, underline } from "colorette" console.log( blue("I'm blue"), bold(blue("da ba dee")), underline(bold(blue("da ba daa"))) ) ``` Here's an example using [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals). ```js console.log(` There's a ${underline(blue("house"))}, With a ${bold(blue("window"))}, And a ${blue("corvette")} And everything is blue `) ``` You can also nest styles without breaking existing color sequences. ```js console.log(bold(`I'm ${blue(`da ba ${underline("dee")} da ba`)} daa`)) ``` Need to override terminal color detection? You can do that too. ```js import { createColors } from "colorette" const { blue } = createColors({ useColor: false }) console.log(blue("Blue? Nope, nah")) ``` ## Installation ```console npm install colorette ``` ## API ### \() > See all [supported colors](#supported-colors). ```js import { blue } from "colorette" blue("I'm blue") //=> \x1b[34mI'm blue\x1b[39m ``` ### createColors() Override terminal color detection via `createColors({ useColor })`. ```js import { createColors } from "colorette" const { blue } = createColors({ useColor: false }) ``` ### isColorSupported `true` if your terminal supports color, `false` otherwise. Used internally, but exposed for convenience. ## Environment You can override color detection from the CLI by setting the `--no-color` or `--color` flags. ```console $ ./example.js --no-color | ./consumer.js ``` Or if you can't use CLI flags, by setting the `NO_COLOR=` or `FORCE_COLOR=` environment variables. ```console $ NO_COLOR= ./example.js | ./consumer.js ``` ## Supported colors | Colors | Background Colors | Bright Colors | Bright Background Colors | Modifiers | | ------- | ----------------- | ------------- | ------------------------ | ----------------- | | black | bgBlack | blackBright | bgBlackBright | dim | | red | bgRed | redBright | bgRedBright | **bold** | | green | bgGreen | greenBright | bgGreenBright | hidden | | yellow | bgYellow | yellowBright | bgYellowBright | _italic_ | | blue | bgBlue | blueBright | bgBlueBright | underline | | magenta | bgMagenta | magentaBright | bgMagentaBright | ~~strikethrough~~ | | cyan | bgCyan | cyanBright | bgCyanBright | reset | | white | bgWhite | whiteBright | bgWhiteBright | | | gray | | | | | ## [Benchmarks](https://github.com/jorgebucaran/colorette/actions/workflows/bench.yml) ```console npm --prefix bench start ``` ```diff chalk 1,786,703 ops/sec kleur 1,618,960 ops/sec colors 646,823 ops/sec ansi-colors 786,149 ops/sec picocolors 2,871,758 ops/sec + colorette 3,002,751 ops/sec ``` ## Acknowledgments Colorette started out in 2015 by [@jorgebucaran](https://github.com/jorgebucaran) as a lightweight alternative to [Chalk](https://github.com/chalk/chalk) and was introduced originally as [Clor](https://github.com/jorgebucaran/colorette/commit/b01b5b9961ceb7df878583a3002e836fae9e37ce). Our terminal color detection logic borrows heavily from [@sindresorhus](https://github.com/sindresorhus) and [@Qix-](https://github.com/Qix-) work on Chalk. The idea of slicing strings to clear bleeding sequences was adapted from a similar technique used by [@alexeyraspopov](https://github.com/alexeyraspopov) in [picocolors](https://github.com/alexeyraspopov/picocolors). Thank you to all our contributors! <3 ## License [MIT](LICENSE.md) --- _Source: https://npm.io/package/colorette Β· Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._