boxt
v1.1.2
Published
📦 Create boxes around text
Downloads
2,316
Readme
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'
| |
| theme: 'round'
color: 'green'
| |
| padding: 10
align: 'left'
| |
| title 'I am the title'.bold
|