boks v1.0.3

boks

Border or boxes that can be used to wrap text.

Similar to cli-boxes but includes:

• Abitilty to have different top, bottom, left and right borders.
• Ability to have intersections +.
• Attempt to discover intersection and corner types based on provided values.

Install

npm install boks

Usage

const boks = require('boks');

console.log(boks.templates.single);
/*
┌─┬─┐
│ │ │
├─┼─┤
│ │ │
└─┴─┘
*/
// OR

const options = {
	horizontal: borders.HorizontalLines.line,
	vertical: borders.VerticalLines.double,
};

console.log(boks.getBorder(options));
/*
 ╓─╥─╖
 ║ ║ ║
 ╟─╫─╢
 ║ ║ ║
 ╙─╨─╜
*/

Exposed functions

• getBorder: build the borders from an options object (or an array of options objects).
• fixMultiple: Fix missing borders based on an array of option object.
• fixBorders: Fix missing borders based on a options object.
• fixCorners: Only fix the missing corner values of an outside border.
• fixIntersections: fix Intersection values (+) based on values of surrounding border types.

Standard templates available

• empty: no borders;
• single: single lined borders;
• round: single lined with rounded corner borders;
• double: double lined borders;
• singleDouble: single horizontal lines, double vertical lines;
• doubleSingle: double horizontal lines, single vertical lines;
• boldSingle: bold horizontal lines, single vertical lines;
• singleBold: single horizontal lines, bold vertical lines;

Options

Options are passed as an object and can have the following properties:

Please note

Not all border types have corresponding intersection types and the best solution is sought.

Contributions

Any contributions are welcome.

Patches

• 1.0.1
  • update the node version from >=8.5.0 to >=10.0.0.