Display a title at the top of the box.
If needed, the box will horizontally expand to fit the title.
Example:
console.log(boxen('foo bar', {title: 'example'}));/*┌ example ┐│foo bar │└─────────┘*/
titleColor
Type: string
Default: borderColor if set, otherwise the terminal's text color
Values: 'black''red''green''yellow''blue''magenta''cyan''white''gray''grey''blackBright''redBright''greenBright''yellowBright''blueBright''magentaBright''cyanBright''whiteBright' or a hex value like '#ff0000'
Color of the title.
Styling already applied to the title takes precedence over this option.
Example:
// Blue border with a red titleconsole.log(boxen('foo bar', {title: 'example', borderColor: 'blue', titleColor: 'red'}));/*┌ example ┐│foo bar │└─────────┘*/
titleAlignment
Type: string
Default: 'left'
Align the title in the top bar.
Values:
'left'
/*┌ example ──────┐│foo bar foo bar│└───────────────┘*/
'center'
/*┌─── example ───┐│foo bar foo bar│└───────────────┘*/
'right'
/*┌────── example ┐│foo bar foo bar│└───────────────┘*/
footer
Type: string
Display a footer at the bottom of the box.
If needed, the box will horizontally expand to fit the footer.
The footer uses the border color.
Example:
console.log(boxen('foo bar', {footer: 'example'}));/*┌─────────┐│foo bar │└ example ┘*/
footerAlignment
Type: string
Default: 'left'
Align the footer in the bottom bar.
Values:
'left'
/*┌───────────────┐│foo bar foo bar│└ example ──────┘*/
'center'
/*┌───────────────┐│foo bar foo bar│└─── example ───┘*/
'right'
/*┌───────────────┐│foo bar foo bar│└────── example ┘*/
width
Type: number or a numeric string
Set a fixed width for the box.
A numeric string is also accepted.
Note: This disables terminal overflow handling and may cause the box to look broken if the user's terminal is not wide enough.
import boxen from 'boxen';console.log(boxen('foo bar', {width: 15}));// ┌─────────────┐// │foo bar │// └─────────────┘
maxWidth
Type: number or a numeric string
Set a maximum width for the box.
A numeric string is also accepted.
The box grows with the content and does not become wider than this value.
A character that is wider than the space left for it can still widen the box, because a character is never split.
Note: This option has no effect when width is set.
import boxen from 'boxen';console.log(boxen('foo bar', {maxWidth: 20}));// ┌───────┐// │foo bar│// └───────┘console.log(boxen('Lorem ipsum dolor sit amet, consectetur.', {maxWidth: 20}));// ┌─────────────────┐// │Lorem ipsum dolor│// │sit amet, │// │consectetur. │// └─────────────────┘
Accepts a number or an object with any of the top, right, bottom, left properties. When a number is specified, the left/right padding is 3 times the top/bottom to make it look nice.
margin
Type: number | object
Default: 0
Space around the box.
Accepts a number or an object with any of the top, right, bottom, left properties. When a number is specified, the left/right margin is 3 times the top/bottom to make it look nice.