OrgGo
/
termdash
mirror of https://github.com/mum4k/termdash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Created Mouse api (markdown)

Jakub Sobon 2019-02-24 17:38:42 -05:00
parent 538a383642
commit 2f69019c8d
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Mouse-api.md Normal file

@ -0,0 +1,18 @@
# Mouse API
[![Doc Status](https://godoc.org/github.com/mum4k/termdash/mouse?status.png)](https://godoc.org/github.com/mum4k/termdash/mouse)
The [mouse](https://github.com/mum4k/termdash/tree/master/mouse) package exposes types that represent mouse buttons.
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:
## [mouse.Button](https://github.com/mum4k/termdash/blob/1a7bcf40e818109611d0b8a49b5994085a20b479/mouse/mouse.go#L18-L19)
The **mouse.Button** type represents mouse buttons. The package provides predefined values for the recognised mouse buttons.
```go
var button mouse.Button
button = mouse.ButtonLeft
```