From 7e8911ce9d56c4108725aa30e3fb920db61c780f Mon Sep 17 00:00:00 2001 From: Jakub Sobon Date: Sun, 24 Feb 2019 17:51:24 -0500 Subject: [PATCH] Created Align api (markdown) --- Align-api.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 Align-api.md diff --git a/Align-api.md b/Align-api.md new file mode 100644 index 0000000..20a7d9c --- /dev/null +++ b/Align-api.md @@ -0,0 +1,25 @@ +# Align API + +[![Doc Status](https://godoc.org/github.com/mum4k/termdash/align?status.png)](https://godoc.org/github.com/mum4k/termdash/align) + +The [align](https://github.com/mum4k/termdash/tree/master/align) package exposes types that specify the alignment of elements. + +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: + +## [align.Horizontal](https://github.com/mum4k/termdash/blob/1a7bcf40e818109611d0b8a49b5994085a20b479/align/align.go#L18-L19) + +The **align.Horizontal** specifies the horizontal alignment of an element. The package provides predefined values for the following alignments: + +- Left. +- Center. +- Right. + +## [align.Vertical](https://github.com/mum4k/termdash/blob/1a7bcf40e818109611d0b8a49b5994085a20b479/align/align.go#L45-L46) + +The **align.Vertical** specifies the vertical alignment of an element. The package provides predefined values for the following alignments: + +- Top. +- Middle. +- Bottom. \ No newline at end of file