gocui-widgets
Set of thin gocui widgets with higher-level abstractions such as event listeners and changers to help you build TUI apps. It is meant to use with gocui not instead.
go get github.com/shilangyu/gocui-widgets
Usage
All widgets implement gocui.Manager therefore can be added as managers or rendered directly with Widget.Layout(g).
All widgets expose their *gocui.View in the Widget.View property.
All widget have a widget type to distinguish them apart in the Widget.Type property.
Some widgets accept callback functions called OnSomething that are called when Something happens.
Some widgets have changers methods called ChangeSomething that you call with gocui.Update whenever you need to change Something.
Check the _examples to find out more and godoc for a more thorough documentation
Widgets
Text
Plain text
NewText(name, text string, frame, center bool, x, y int)
Parameters:
| name | description |
|---|---|
| name | ID of your widget (passed to the gocui.View) |
| text | value to the printed in your widget |
| frame | if true a frame is rendered |
| center | if true x and y become the center of the widget |
| x, y | coordinates of the widget |
Changers:
| name | description |
|---|---|
| ChangeText | changes the inner text of the widget |
Collection
Grouping frame with a title
NewCollection(name, title string, center bool, x, y int, w, h int)
Parameters:
| name | description |
|---|---|
| name | ID of your widget (passed to the gocui.View) |
| title | title to be printed |
| center | if true x and y become the center of the widget |
| x, y | coordinates of the widget |
| w, h | size of the widget |
Changers:
| name | description |
|---|---|
| ChangeTitle | changes the title of the widget |
Input
Input field
NewInput(name string, frame, center bool, x, y int, w, h int, onChange func(v *gocui.View, key gocui.Key, ch rune, mod gocui.Modifier) bool)
Parameters:
| name | description |
|---|---|
| name | ID of your widget (passed to the gocui.View) |
| frame | if true a frame is rendered |
| center | if true x and y become the center of the widget |
| x, y | coordinates of the widget |
| w, h | size of the widget |
Changers:
| name | description |
|---|---|
| ChangeText | changes the input text |
Listeners:
| name | description |
|---|---|
| onChange | a gocui.EditorFunc function that returns a bool, if returned false this change wont be accepted and the input will stay unchanged |
Menu
Items menu (make sure to set g.Mouse to true for mouse support)
NewMenu(name string, items []string, center, arrows bool, x, y int, onChange, onSubmit func(i int))
Parameters:
| name | description |
|---|---|
| name | ID of your widget (passed to the gocui.View) |
| items | slice of items in your menu |
| center | if true x and y become the center of the widget |
| x, y | coordinates of the widget |
Listeners:
| name | description |
|---|---|
| onChange | accepts the index of currently selected item, ran whenever a new item is selected |
| onSubmit | accepts the index of the submitted item, ran whenever an item is double clicked or pressed with Enter |
Changers:
| name | description |
|---|---|
| ChangeSelected | changes the selected menu item |
Menu
Modal with options (make sure to set g.Mouse to true for mouse support)
NewModal(name string, text string, choices []string, center bool, x, y int, onChange, onSubmit func(i int))
Parameters:
| name | description |
|---|---|
| name | ID of your widget (passed to the gocui.View) |
| text | message text to be displayed |
| choices | slice of choices in the modal |
| center | if true x and y become the center of the widget |
| x, y | coordinates of the widget |
Listeners:
| name | description |
|---|---|
| onChange | accepts the index of currently selected item, ran whenever a new item is selected |
| onSubmit | accepts the index of the submitted item, ran whenever an item is double clicked or pressed with Enter |
Hide with
modal.Hide()
Examples
To run a widget example clone this repo and go to the _examples directory. Then:
go run <widget-name>.go
