Skip to content

omrilotan/boxt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

boxt

boxt

boxt

Use

npm i -S boxt

const boxt = require('boxt');

boxt(`I have a message
It might be multilined`);

Options

boxt(
	'Guests, like fish, begin to smell after three days.',
	{
		color: 'green',
		theme: 'round',
		padding: 4,
		align: 'center',
		minWidth: 100
	}
);
option meaning values
title A title And string
theme border style 'single' (default), 'double', 'round'
color border colour see chalk on NPM
padding space from borders to text
align Where to align the lines 'center' (default), 'left'/'start', 'right'/'end'
minWidth Minimal width any number or 'full' for full terminal width

Examples

options result
theme: 'double'
color: 'bgBlue'
example
theme: 'round'
color: 'green'
example
padding: 10
align: 'left'
example
title 'I am the title'.bold example

About

📦 Create boxes around text

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published