1
0
mirror of https://github.com/mum4k/termdash.git synced 2025-04-27 13:48:49 +08:00

Created Align api (markdown)

Jakub Sobon 2019-02-24 17:51:24 -05:00
parent 264ccc77d9
commit 7e8911ce9d

25
Align-api.md Normal file

@ -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.