Skip to content

[NPM Package] boxedText : A lightweight utility to center and wrap text in customizable Ascii boxes for CLI

Notifications You must be signed in to change notification settings

Cafeine-Software/boxedText

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Boxed Text

errorUnstack

Node

Display a text in an ascii box

InstallationUsageDocumentationLicenseContactSupport

Description

A lightweight utility to wrap text in customizable Unicode boxes. It automatically centers the text and can output directly to the console or return a formatted multi-line string.

Installation

npm i @cafeine-software/boxed-text

Usage

import { boxedText ,BOX_STYLE} from "@cafeine-software/boxed-text";

// Display the boxed text with default style BOX_STYLE.LIGHT
boxedText(style);

// Get the boxed text as a string
const boxedText = boxedTest("BAR",BOX_STYLE.HEAVY,false)

Documentation

Available style are :

  • LIGHT
  • HEAVY
  • DOUBLE
  • ROUNDED
  • VERTICAL_LIGHT_&_HEAVY_TOP
  • VERTICAL_HEAVY_&__LIGHT_TOP
  • VERTICAL_LIGHT_&_DOUBLE_TOP
  • VERTICAL_DOUBLE_&_LIGHT_TOP

License

Contact

Developed by Quentin Lamamy.

Support

Buy Me A Coffee

About

[NPM Package] boxedText : A lightweight utility to center and wrap text in customizable Ascii boxes for CLI

Topics

Resources

Stars

Watchers

Forks

Contributors