diff options
Diffstat (limited to 'vendor/github.com/jroimartin/gocui/README.md')
| -rw-r--r-- | vendor/github.com/jroimartin/gocui/README.md | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/vendor/github.com/jroimartin/gocui/README.md b/vendor/github.com/jroimartin/gocui/README.md new file mode 100644 index 00000000..d2e5065f --- /dev/null +++ b/vendor/github.com/jroimartin/gocui/README.md @@ -0,0 +1,91 @@ +# GOCUI - Go Console User Interface + +[](https://godoc.org/github.com/jroimartin/gocui) + +Minimalist Go package aimed at creating Console User Interfaces. + +## Features + +* Minimalist API. +* Views (the "windows" in the GUI) implement the interface io.ReadWriter. +* Support for overlapping views. +* The GUI can be modified at runtime (concurrent-safe). +* Global and view-level keybindings. +* Mouse support. +* Colored text. +* Customizable edition mode. + +## Installation + +Execute: + +``` +$ go get github.com/jroimartin/gocui +``` + +## Documentation + +Execute: + +``` +$ go doc github.com/jroimartin/gocui +``` + +Or visit [godoc.org](https://godoc.org/github.com/jroimartin/gocui) to read it +online. + +## Example + +```go +package main + +import ( + "fmt" + "log" + + "github.com/jroimartin/gocui" +) + +func main() { + g := gocui.NewGui() + if err := g.Init(); err != nil { + log.Panicln(err) + } + defer g.Close() + + g.SetLayout(layout) + + if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil { + log.Panicln(err) + } + + if err := g.MainLoop(); err != nil && err != gocui.ErrQuit { + log.Panicln(err) + } +} + +func layout(g *gocui.Gui) error { + maxX, maxY := g.Size() + if v, err := g.SetView("hello", maxX/2-7, maxY/2, maxX/2+7, maxY/2+2); err != nil { + if err != gocui.ErrUnknownView { + return err + } + fmt.Fprintln(v, "Hello world!") + } + return nil +} + +func quit(g *gocui.Gui, v *gocui.View) error { + return gocui.ErrQuit +} +``` + +## Screenshots + +_examples/demo.go: + + + +_examples/dynamic.go: + + |