Nevertheless Published Mine
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    boxenpublic

    boxen

    Create boxes in the terminal

    Build Status

    Install

    $ npm install boxen
    

    Usage

    const boxen = require('boxen');
     
    console.log(boxen('unicorn', {padding: 1}));
    /*
    ┌─────────────┐
    │             │
    │   unicorn   │
    │             │
    └─────────────┘
    */
     
    console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));
    /*
     
       ╔═════════════╗
       ║             ║
       ║   unicorn   ║
       ║             ║
       ╚═════════════╝
     
    */

    API

    boxen(input, [options])

    input

    Type: string

    Text inside the box.

    options

    borderColor

    Type: string
    Values: black red green yellow blue magenta cyan white gray

    Color of the box border.

    borderStyle

    Type: string object
    Default: single
    Values:

    • single
    ┌───┐
    │foo│
    └───┘
    
    • double
    ╔═══╗
    ║foo║
    ╚═══╝
    
    • round (single sides with round corners)
    ╭───╮
    │foo│
    ╰───╯
    
    • single-double (single on top and bottom, double on right and left)
    ╓───╖
    ║foo║
    ╙───╜
    
    • double-single (double on top and bottom, single on right and left)
    ╒═══╕
    │foo│
    ╘═══╛
    
    • classic
    +---+
    |foo|
    +---+
    

    Style of the box border.

    Can be any of the above predefined styles or an object with the following keys:

    {
        topLeft: '+',
        topRight: '+',
        bottomLeft: '+',
        bottomRight: '+',
        horizontal: '-',
        vertical: '|'
    }
    dimBorder

    Type: boolean
    Default: false

    Reduce opacity of the border.

    padding

    Type: number Object
    Default: 0

    Space between the text and box border.

    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.

    float

    Type: string
    Values: right center left
    Default: left

    Float the box on the available terminal screen space.

    backgroundColor

    Type: string
    Values: black red green yellow blue magenta cyan white

    Color of the background.

    align

    Type: string
    Default: left
    Values: left center right

    Align the text in the box based on the widest line.

    Related

    License

    MIT © Sindre Sorhus

    install

    npm i boxen

    Downloadslast 7 days

    1,560,575

    version

    1.3.0

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar