Mena is a dynamic progress bar class for Node.js console applications, offering customizable visual elements for real-time progress tracking. Ideal for CLI tools, it enhances user interaction with progress visualization.

::: tip Mena is designed for ease of use and customization, focusing on console progress display. For additional features or complex console UIs, consider specialized libraries. :::

• Customizable Progress Bar: Tailor the length, characters, and colors of the progress bar.
• Real-time Updates: Dynamically update the progress bar in response to application events.
• Color Support: Set different colors for complete and incomplete segments.
• Ease of Use: Simple API for quick integration into Node.js applications.

Install Mena in your Node.js project via npm. Ensure your environment supports ESModule syntax for seamless integration. Run the following command:

npm install mena

To use Mena, import it into your Node.js project, create an instance, and utilize its methods to display and update the progress bar.

import Mena from 'mena';

const progressBar = new Mena();
progressBar.update(0.5, 'Processing...'); // Update the progress bar to 50%

• Mena(options?: MenaOptions) - Initializes the progress bar with optional custom settings.

• update(value: string | number, text?: string): void - Updates the progress bar or displays a message.

The MenaOptions interface allows for customization of the progress bar. It includes the following optional properties:

• barLength: number - Specifies the length of the progress bar.
• completedChar: string - Character representing completed segments.
• incompleteChar: string - Character representing incomplete segments.
• barStartChar: string - Character to be used at the start of the progress bar.
• barEndChar: string - Character to be used at the end of the progress bar.
• completeCharColor: Color[] - Array of RGB colors for completed segments.
• incompleteCharColor: Color[] - Array of RGB colors for incomplete segments.

Represents an RGB color as a tuple of three numbers [number, number, number].

Contributions to Mena are welcome. This library is part of the toolx library.

Mena is open-sourced under the MIT license, suitable for both personal and commercial use.