Logo for jsDocs.io

cli-boxes

  • Version 3.0.0
  • Published
  • 6.62 kB
  • No dependencies
  • MIT license

Install

npm i cli-boxes
yarn add cli-boxes
pnpm add cli-boxes

Overview

Boxes for use in the terminal

Index

Variables

Interfaces

Variables

variable cliBoxes

const cliBoxes: cliBoxes.Boxes & { default: typeof cliBoxes };

  • Boxes for use in the terminal.

    Example 1

    import cliBoxes = require('cli-boxes');
    

    console.log(cliBoxes.single);
    // {
    // 	topLeft: '┌',
    // 	top: '─',
    // 	topRight: '┐',
    // 	right: '│',
    // 	bottomRight: '┘',
    // 	bottom: '─',
    // 	bottomLeft: '└',
    // 	left: '│'
    // }

Interfaces

interface Boxes

interface Boxes {}

  • All box styles.

property arrow

readonly arrow: BoxStyle;

  • Example 1

    ``` ↘↓↓↓↓↙ → ← ↗↑↑↑↑↖ ```

property bold

readonly bold: BoxStyle;

  • Example 1

    ``` ┏━━━━┓ ┃ ┃ ┗━━━━┛ ```

property classic

readonly classic: BoxStyle;

  • Example 1

    ``` +----+ | | +----+ ```

property double

readonly double: BoxStyle;

  • Example 1

    ``` ╔════╗ ║ ║ ╚════╝ ```

property doubleSingle

readonly doubleSingle: BoxStyle;

  • Example 1

    ``` ╒════╕ │ │ ╘════╛ ```

property round

readonly round: BoxStyle;

  • Example 1

    ``` ╭────╮ │ │ ╰────╯ ```

property single

readonly single: BoxStyle;

  • Example 1

    ``` ┌────┐ │ │ └────┘ ```

property singleDouble

readonly singleDouble: BoxStyle;

  • Example 1

    ``` ╓────╖ ║ ║ ╙────╜ ```

interface BoxStyle

interface BoxStyle {}

  • Style of the box border.

property bottom

readonly bottom: string;

    property bottomLeft

    readonly bottomLeft: string;

      property bottomRight

      readonly bottomRight: string;

        property left

        readonly left: string;

          property right

          readonly right: string;

            property top

            readonly top: string;

              property topLeft

              readonly topLeft: string;

                property topRight

                readonly topRight: string;

                  Package Files (1)

                  Dependencies (0)

                  No dependencies.

                  Dev Dependencies (3)

                  Peer Dependencies (0)

                  No peer dependencies.

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/cli-boxes.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/cli-boxes)
                  • HTML
                    <a href="https://www.jsdocs.io/package/cli-boxes"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>