Created Linestyle API (markdown)

Jakub Sobon 2019-02-24 17:54:37 -05:00
parent 3c3c366886
commit 49d76a19f1
1 changed files with 15 additions and 0 deletions

15
Linestyle-API.md Normal file

@ -0,0 +1,15 @@
# Linestyle API
[![Doc Status](https://godoc.org/github.com/mum4k/termdash/linestyle?status.png)](https://godoc.org/github.com/mum4k/termdash/linestyle)
The [linestyle](https://github.com/mum4k/termdash/tree/master/linestyle) package exposes types that identify styles of lines drawn on the terminal. Lines are typically used when drawing boxes or borders.
This is a data-only package which provides types that are accepted by the infrastructure and widgets in multiple locations.
The public API surface of this package consists of the following:
## [linestyle.LineStyle](https://github.com/mum4k/termdash/blob/1c6947618b08ae236959763efd07278be5f03211/linestyle/linestyle.go#L18-L19)
The **linestyle.LineStyle** type represents a style of a line. All line style utilize the Unicode box drawing characters documented here:
- https://en.wikipedia.org/wiki/Box-drawing_character