# README
GOCUI - Go Console User Interface
Minimalist Go library aimed at creating Console User Interfaces.
Installation
go get github.com/jroimartin/gocui
Documentation
godoc github.com/jroimartin/gocui
Example
func layout(g *gocui.Gui) error {
maxX, maxY := g.Size()
if v, err := g.SetView("center", maxX/2-10, maxY/2, maxX/2+10, maxY/2+2); err != nil {
if err != gocui.ErrorUnkView {
return err
}
fmt.Fprintln(v, "This is an example")
}
return nil
}
func quit(g *gocui.Gui, v *gocui.View) error {
return gocui.ErrorQuit
}
func main() {
var err error
g := gocui.NewGui()
if err := g.Init(); err != nil {
log.Panicln(err)
}
defer g.Close()
g.SetLayout(layout)
if err := g.SetKeybinding("", gocui.KeyCtrlC, 0, quit); err != nil {
log.Panicln(err)
}
err = g.MainLoop()
if err != nil && err != gocui.ErrorQuit {
log.Panicln(err)
}
}
# Functions
NewGui returns a new Gui object.
# Constants
Text style attributes.
Text style attributes.
Text style attributes.
Color attributes.
Color attributes.
Color attributes.
Color attributes.
Color attributes.
Color attributes.
Color attributes.
Color attributes.
Color attributes.
Special keys.
Special keys.
Special keys.
Special keys.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Keys combinations.
Special keys.
Special keys.
Keys combinations.
Keys combinations.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Special keys.
Keys combinations.
Keys combinations.
Modifiers.
# Variables
ErrorQuit is used to decide if the MainLoop finished succesfully.
ErrorUnkView allows to assert if a View must be initialized.
# Type aliases
Attributes can be combined using bitwise OR (|).
No description provided by the author
No description provided by the author
No description provided by the author