diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/cli-boxes/readme.md | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/cli-boxes/readme.md')
| -rw-r--r-- | node_modules/cli-boxes/readme.md | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/node_modules/cli-boxes/readme.md b/node_modules/cli-boxes/readme.md new file mode 100644 index 00000000..b81816bc --- /dev/null +++ b/node_modules/cli-boxes/readme.md @@ -0,0 +1,94 @@ +# cli-boxes [](https://travis-ci.org/sindresorhus/cli-boxes) + +> Boxes for use in the terminal + +The list of boxes is just a [JSON file](boxes.json) and can be used wherever. + + +## Install + +``` +$ npm install --save cli-boxes +``` + + +## Usage + +```js +const cliBoxes = require('cli-boxes'); + +console.log(cliBoxes.single); +/* +{ + "topLeft": "┌", + "topRight": "┐", + "bottomRight": "┘", + "bottomLeft": "└", + "vertical": "│", + "horizontal": "─" +} +*/ +``` + + +## API + +### cliBoxes + +#### `single` + +``` +┌────┐ +│ │ +└────┘ +``` + +#### `double` + +``` +╔════╗ +║ ║ +╚════╝ +``` + +#### `round` + +``` +╭────╮ +│ │ +╰────╯ +``` + +#### `single-double` + +``` +╓────╖ +║ ║ +╙────╜ +``` + +#### `double-single` + +``` +╒════╕ +│ │ +╘════╛ +``` + +#### `classic` + +``` ++----+ +| | ++----+ +``` + + +## Related + +- [boxen](https://github.com/sindresorhus/boxen) - Create boxes in the terminal + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |