Updated Keyboard API (markdown)

Jakub Sobon 2019-03-02 18:30:43 -05:00
parent 88c14e7024
commit 2279fac85c
1 changed files with 2 additions and 2 deletions

@ -2,13 +2,13 @@
[![Doc Status](https://godoc.org/github.com/mum4k/termdash/keyboard?status.png)](https://godoc.org/github.com/mum4k/termdash/keyboard)
The [keyboard](https://github.com/mum4k/termdash/tree/master/keyboard) package exposes types that represent keys on the keyboard.
The [keyboard](https://godoc.org/github.com/mum4k/termdash/keyboard) package exposes types that represent keys on the keyboard.
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:
## [keyboard.Key](https://github.com/mum4k/termdash/blob/b8591308b93dbd58d97e3a83998e180ecc17cf11/keyboard/keyboard.go#L18-L22)
## [keyboard.Key](https://godoc.org/github.com/mum4k/termdash/keyboard#Key)
The **keyboard.Key** type represents keys on the keyboard. The package provides predefined values for some of the keys which can be used directly, e.g: