to-ansi
v1.4.4
Published
Convert HTML, RGB or HSL to ANSI
Downloads
3,209
Maintainers
Readme
Texts colorizer for terminals..
Easily change terminal content style with to-ansi.
Installation
npm install to-ansi
Usage
With commonJs
const toAnsi = require("to-ansi");
With ESM
import toAnsi from "to-ansi";
Examples
Convert Hex, RGB, HSL or Color name to ANSI
toAnsi.fromHexa("#00FF00"); // => \x1b[38;5;46m
toAnsi.fromRgb({red: 0, blue: 0, green: 255}) // => \x1b[38;5;46m
toAnsi.fromColor("green"); // => \x1b[38;5;46m
toAnsi.fromHsl({hue: 0.5, saturation: 0.5, lightness: 0.5})
Apply colors to the console via the fromHexa function
console.log(
toAnsi.fromHexa("#00FF00") + // Green text
toAnsi.fromHexa("#FF0000", false) + // Red background (false = background)
toAnsi.STYLE.Underline + // Underline text
toAnsi.STYLE.Bold + // Bold text
"Okay" + // Text to display
toAnsi.RESET
);
Apply colors to the console via the getText function (Recommended way)
// Yellow
console.log( toAnsi.getTextFromColor("Hello you!", {fg: "yellow"}) );
// Yellow with blue background
console.log( toAnsi.getTextFromHex("Hello you!", {fg: "#FFFF00", bg: "#0000FF"}) );
// Yellow-ish on purple-lish
console.log( toAnsi.getTextFromHex("Hello you!", {fg: "#FFCCFF", bg: "#DD00FF", isUnderline: true}) );
getTextFromColor
All call below are valid
toAnsi.getTextFromColor("Hello you!", {fg: "red"})
toAnsi.getTextFromColor("Hello you!", {fg: "#FF0000"})
toAnsi.getTextFromColor("Hello you!", {fg: {red: 255, green: 0, blue: 0}})
toAnsi.getTextFromColor("Hello you!", {fg: {hue: 0, saturation: 1, lightness: 0.5}})
Utility functions
// Convert rgb to Hex
toAnsi.rgbToHex({red: 255, blue: 255, green: 255})
// Convert Hex to RGB
toAnsi.hexToRgb("#fff");
// Convert HSL to RGB
toAnsi.hslToRgb({hue: 0, saturation: 1, lightness: 0.5});
// Convert color name to Hex
toAnsi.colorNameToHex("red");