OrgGo/termdash
1
0
Fork 0
mirror of https://github.com/mum4k/termdash.git synced 2025-04-25 13:48:50 +08:00
Code Issues Projects Releases Wiki Activity

Updated Terminal API (markdown)

Jakub Sobon 2019-03-02 18:32:27 -05:00
parent 6db94f204b
commit 4ec60418d0
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Terminal-API.md

@ -2,15 +2,15 @@
[![Doc Status](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi?status.png)](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi)
The [terminalapi](https://github.com/mum4k/termdash/tree/master/terminal/terminalapi) package exposes types that are common to all terminal implementations. This abstraction was created so that users of Termdash can choose which low-level terminal library they prefer.
The [terminalapi](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi) package exposes types that are common to all terminal implementations. This abstraction was created so that users of Termdash can choose which low-level terminal library they prefer.
The public API surface of this package consists of the following:
## [terminalapi.Terminal](https://github.com/mum4k/termdash/blob/ffbf88caeddb1735dcf2a5f735eec80dc9cf9fe7/terminal/terminalapi/terminalapi.go#L25-L52)
## [terminalapi.Terminal](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi#Terminal)
All terminal implementations must implement this interface.
## [terminalapi.ColorMode](https://github.com/mum4k/termdash/blob/ffbf88caeddb1735dcf2a5f735eec80dc9cf9fe7/terminal/terminalapi/color_mode.go#L19-L20)
## [terminalapi.ColorMode](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi#ColorMode)
The **ColorMode** property specifies which colors can be displayed on the terminal and how are they addressed.
@ -21,7 +21,7 @@ Refer to the following pages which provide a list of colors and their numbers:
Colors are set as options on terminal cells. Refer to the [[Cell API|cell-api]] for more details.
## [terminalapi.Event](https://github.com/mum4k/termdash/blob/ffbf88caeddb1735dcf2a5f735eec80dc9cf9fe7/terminal/terminalapi/event.go#L28-L31)
## [terminalapi.Event](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi#Event)
This interface represents an input terminal event, which can be one of the following events: