strcolorize v1.1.8

🖍️ strcolorize

strcolorize is a simple and practical library for terminal output colorization that utilizes ANSI and hexadecimal codes for its operation. The way strcolorize operates is different, using inline formatting for its functionality.

Inline Formatting

Allows adding colors directly to text using codes (Hexadecimal and ANSI) around desired portions. This provides a simple way to highlight important information without compromising the text's structure. With strcolorize, this approach enables precise customization of text colors and styles.

📦 Installation

You can install this library using npm or yarn

npm install strcolorize@latest

yarn install strcolorize@latest

📌 How to usage

To utilize this library, first install it in your project and then import it into your file like this:

// Importing using es6
import colorize from 'strcolorize';

// Importing using commonjs
const colorize = require('strcolorize');

// Note: in place of 'colorize' you can set any name you want

After that, you can use it to colorize your strings like this:

// putting a text in bold and yellow
colorize('#bold yellow[The sun sets. Stars twinkle. Dreams awaken.
]');

// you can print to the console using the function itself
colorize('#bold yellow[The sun sets. Stars twinkle. Dreams awaken.
]', true);

// There's the possibility of nesting styles
colorize('#bold[The sun sets. #yellow[Stars twinkle]. Dreams awaken.
]');

// How to use hexadecimal codes to colorize your strings
colorize('#bold[The sun sets. #ff0[Stars twinkle]. Dreams awaken.
]');

📝 Method

colorize(text: string, terminal: boolean = false): string | void

• text: The text to be colorized.
• terminal: A boolean flag indicating whether to print the colorized text directly to the terminal.
• return: is true, prints the colorized text to the terminal and returns void. Otherwise, returns the colorized text as a string.

💖 Contribuition

Your contributions are highly valued! Feel free to enhance this project by opening an issue to report any problems or submitting a pull request with your proposed changes.

Ansi Styles