Skip to content

Minimalist Go package aimed at creating Console User Interfaces.

License

Notifications You must be signed in to change notification settings

stretto-editor/gocui

 
 

Repository files navigation

GOCUI - Go Console User Interface

GoDoc

Minimalist Go package aimed at creating Console User Interfaces.

About the fork

This fork is based on GOCUI v0.2.0. The library was modified to suit the need of Stretto editor.

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.
  • Customizable edition mode.

Installation

Execute:

$ go get github.com/jroimartin/gocui

Documentation

Execute:

$ godoc github.com/jroimartin/gocui

Or visit godoc.org to read it online.

Example

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/demo.go

_examples/dynamic.go:

_examples/dynamic.go

About

Minimalist Go package aimed at creating Console User Interfaces.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%