diff options
Diffstat (limited to 'Godeps/_workspace/src/github.com/gizak/termui/README.md')
| -rw-r--r-- | Godeps/_workspace/src/github.com/gizak/termui/README.md | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/Godeps/_workspace/src/github.com/gizak/termui/README.md b/Godeps/_workspace/src/github.com/gizak/termui/README.md new file mode 100644 index 000000000..b9bc3024d --- /dev/null +++ b/Godeps/_workspace/src/github.com/gizak/termui/README.md @@ -0,0 +1,159 @@ +# termui [](https://travis-ci.org/gizak/termui) [](https://godoc.org/github.com/gizak/termui) + +## Update 23/06/2015 +Pull requests and master branch are freezing, waiting for merging from `refactoring` branch. + +## Notice +termui comes with ABSOLUTELY NO WARRANTY, and there is a breaking change coming up (see refactoring branch) which will change the `Bufferer` interface and many others. These changes reduce calculation overhead and introduce a new drawing buffer with better capacibilities. We will step into the next stage (call it beta) after merging these changes. + +## Introduction +Go terminal dashboard. Inspired by [blessed-contrib](https://github.com/yaronn/blessed-contrib), but purely in Go. + +Cross-platform, easy to compile, and fully-customizable. + +__Demo:__ (cast under osx 10.10; Terminal.app; Menlo Regular 12pt.) + +<img src="./example/dashboard.gif" alt="demo" width="600"> + +__Grid layout:__ + +Expressive syntax, using [12 columns grid system](http://www.w3schools.com/bootstrap/bootstrap_grid_system.asp) +```go + import ui "github.com/gizak/termui" + // init and create widgets... + + // build + ui.Body.AddRows( + ui.NewRow( + ui.NewCol(6, 0, widget0), + ui.NewCol(6, 0, widget1)), + ui.NewRow( + ui.NewCol(3, 0, widget2), + ui.NewCol(3, 0, widget30, widget31, widget32), + ui.NewCol(6, 0, widget4))) + + // calculate layout + ui.Body.Align() + + ui.Render(ui.Body) +``` +[demo code:](https://github.com/gizak/termui/blob/master/example/grid.go) + +<img src="./example/grid.gif" alt="grid" width="500"> + +## Installation + + go get github.com/gizak/termui + +## Usage + +Each component's layout is a bit like HTML block (box model), which has border and padding. + +The `Border` property can be chosen to hide or display (with its border label), when it comes to display, the label takes 1 padding space (i.e. in css: `padding: 1;`, innerHeight and innerWidth therefore shrunk by 1). + +`````go + import ui "github.com/gizak/termui" // <- ui shortcut, optional + + func main() { + err := ui.Init() + if err != nil { + panic(err) + } + defer ui.Close() + + p := ui.NewPar(":PRESS q TO QUIT DEMO") + p.Height = 3 + p.Width = 50 + p.TextFgColor = ui.ColorWhite + p.Border.Label = "Text Box" + p.Border.FgColor = ui.ColorCyan + + g := ui.NewGauge() + g.Percent = 50 + g.Width = 50 + g.Height = 3 + g.Y = 11 + g.Border.Label = "Gauge" + g.BarColor = ui.ColorRed + g.Border.FgColor = ui.ColorWhite + g.Border.LabelFgColor = ui.ColorCyan + + ui.Render(p, g) + + // event handler... + } +````` + +Note that components can be overlapped (I'd rather call this a feature...), `Render(rs ...Renderer)` renders its args from left to right (i.e. each component's weight is arising from left to right). + +## Themes + +_All_ colors in _all_ components can be changed at _any_ time, while there provides some predefined color schemes: + +```go +// for now there are only two themes: default and helloworld +termui.UseTheme("helloworld") + +// create components... +``` +The `default ` theme's settings depend on the user's terminal color scheme, which is saying if your terminal default font color is white and background is white, it will be like: + +<img src="./example/themedefault.png" alt="default" type="image/png" width="600"> + +The `helloworld` color scheme drops in some colors! + +<img src="./example/themehelloworld.png" alt="helloworld" type="image/png" width="600"> + +## Widgets + +#### Par + +[demo code](https://github.com/gizak/termui/blob/master/example/par.go) + +<img src="./example/par.png" alt="par" type="image/png" width="300"> + +#### List +[demo code](https://github.com/gizak/termui/blob/master/example/list.go) + +<img src="./example/list.png" alt="list" type="image/png" width="200"> + +#### Gauge +[demo code](https://github.com/gizak/termui/blob/master/example/gauge.go) + +<img src="./example/gauge.png" alt="gauge" type="image/png" width="350"> + +#### Line Chart +[demo code](https://github.com/gizak/termui/blob/master/example/linechart.go) + +<img src="./example/linechart.png" alt="linechart" type="image/png" width="450"> + +#### Bar Chart +[demo code](https://github.com/gizak/termui/blob/master/example/barchart.go) + +<img src="./example/barchart.png" alt="barchart" type="image/png" width="150"> + +#### Mult-Bar / Stacked-Bar Chart +[demo code](https://github.com/gizak/termui/blob/master/example/mbarchart.go) + +<img src="./example/mbarchart.png" alt="barchart" type="image/png" width="150"> + +#### Sparklines +[demo code](https://github.com/gizak/termui/blob/master/example/sparklines.go) + +<img src="./example/sparklines.png" alt="sparklines" type="image/png" width="350"> + + +## GoDoc + +[godoc](https://godoc.org/github.com/gizak/termui) + +## TODO + +- [x] Grid layout +- [ ] Event system +- [ ] Canvas widget +- [ ] Refine APIs +- [ ] Focusable widgets + +## License +This library is under the [MIT License](http://opensource.org/licenses/MIT) |