mirror of
https://github.com/garraflavatra/trmclr.git
synced 2024-11-21 21:38:57 +01:00
33 lines
1.4 KiB
Markdown
33 lines
1.4 KiB
Markdown
# trmclr
|
|
|
|
- Easy terminal colors, ported from the Deno standard library.
|
|
- Supports Node.js, browsers, Deno, and probably some other environments.
|
|
- Comes with 45 colors and helpers.
|
|
- Respects [`NO_COLOR`](http://no-color.org/).
|
|
- No dependencies.
|
|
- Allows for tree-shaking.
|
|
|
|
## Colors and helpers
|
|
|
|
bgBlack, bgBlue, bgBrightBlack, bgBrightBlue, bgBrightCyan, bgBrightGreen, bgBrightMagenta, bgBrightRed, bgBrightWhite, bgBrightYellow, bgCyan, bgGreen, bgMagenta, bgRed, bgRgb24, bgRgb8, bgWhite, bgYellow, black, blue, bold, brightBlack, brightBlue, brightCyan, brightGreen, brightMagenta, brightRed, brightWhite, brightYellow, cyan, dim, getColorEnabled, gray, green, hidden, inverse, italic, magenta, red, reset, strikethrough, stripColor, underline, white, yellow
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import { cyan, bgMagenta } from 'trmcrl';
|
|
|
|
console.log(cyan(bgMagenta('Some text')));
|
|
```
|
|
|
|
## Enable or disable color
|
|
|
|
By using `setColorEnabled(true)` or `setColorEnabled(false)` you can respectively enable and disable color output. Use `getColorEnabled()` to retrieve the current state.
|
|
|
|
## License
|
|
|
|
(c) 2022-2024 [Romein van Buren](mailto:romein@vburen.nl). Licensed under the MIT license.
|
|
|
|
For the full copyright and license information, please see the [`LICENSE.md`](./LICENSE.md) file that was distributed with this source code.
|
|
|
|
[](https://www.smartyellow.nl)
|