Terminal-based user interface toolkit
Go to file
Andreas Bieber f71273b9c8 feat(dropdown): Expose `DropDownOption`
BREAKING CHANGE:
DropDown:
- The signature of `GetCurrentOption` has been changed to return the index and the newly exposed `DropDownOption`
- `AddOption` has been renamed to `AddOptions` and accepts now multiple `DropDownOption`s. A convenience func called `AddOptionsSimple` has been added to simply add options by only providing its text.
- The signature of `SetOptions` has been changed to accept the global `selected` handler with the newly exposed `DropDownOption` and multiple `DropDownOption`s to set. A convenience func, namely `SetOptionsSimple`, has been added to simply add options by only providing its text.
- The signature of `SetSelectedFunc` has been changed to accept a handler expecting an index and the newly exposed `DropDownOption`

Form:
- The signature of `AddDropDown` has been changed to accept an array of the newly exposed `DropDownOption`. A convenience func, namely `AddDropDownSimple`, has been added to simply add a DropDown by only providing the option's text.
2020-09-23 20:46:36 +02:00
demos feat(dropdown): Expose `DropDownOption` 2020-09-23 20:46:36 +02:00
.gitignore Fork tview as cview 2019-12-30 15:18:26 -08:00
.gitlab-ci.yml Update CI script 2020-01-28 07:10:28 -08:00
CHANGELOG Release v1.4.9 2020-09-08 14:26:39 -07:00
CONTRIBUTING.md Migrate docs to docs.rocketnine.space 2020-02-06 16:06:47 -08:00
DESIGN.md Use sync.RWMutex in all widgets 2020-08-02 10:06:34 -07:00
FORK.md Add TextView.SetReindexBuffer 2020-09-03 19:23:56 -07:00
LICENSE Document TextView.GetText and GetRegionText fix 2020-07-13 14:47:10 -07:00
README.md Add ContextMenu 2020-04-18 20:00:36 -07:00
ansi.go Bugfixes in ANSI escape sequence handling as well as TextView, fixes #320, fixes #344 2020-06-09 14:52:59 -07:00
application.go Use updated tcell mouse buttons 2020-08-31 08:44:33 -07:00
borders.go Fork tview as cview 2019-12-30 15:18:26 -08:00
box.go feat(box): Add `SetBorderColorFocused` 2020-09-23 18:25:18 +02:00
box_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
button.go feat(FormItems): Allow specifying colors for focused state 2020-09-23 20:46:31 +02:00
button_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
checkbox.go feat(FormItems): Allow specifying colors for focused state 2020-09-23 20:46:31 +02:00
checkbox_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
contextmenu.go feat(List): Expose `ListItem` 2020-09-23 20:46:36 +02:00
cview.gif Fork tview as cview 2019-12-30 15:18:26 -08:00
doc.go Update strikethrough implementation 2020-09-01 13:48:27 -07:00
doc_test.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
dropdown.go feat(dropdown): Expose `DropDownOption` 2020-09-23 20:46:36 +02:00
flex.go feat(flex): Add `AddItemAtIndex` 2020-09-23 18:25:22 +02:00
focusable.go Fork tview as cview 2019-12-30 15:18:26 -08:00
form.go feat(dropdown): Expose `DropDownOption` 2020-09-23 20:46:36 +02:00
frame.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
go.mod Base List PageUp and PageDown on the number of items displayed 2020-09-08 14:22:58 -07:00
go.sum Base List PageUp and PageDown on the number of items displayed 2020-09-08 14:22:58 -07:00
grid.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
inputfield.go feat(inputfield/autocompletion): Draw selected autocomplete suggestion in `inputfield` without changing it till confirmed with `ENTER` 2020-09-23 20:46:36 +02:00
keys.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
list.go feat(List): Add additional field for setting an optional reference (like in TreeView) 2020-09-23 20:46:36 +02:00
list_test.go feat(List): Expose `ListItem` 2020-09-23 20:46:36 +02:00
modal.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
pages.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
primitive.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
progressbar.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
progressbar_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
semigraphics.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00
styles.go feat(inputfield/autocompletion): Draw selected autocomplete suggestion in `inputfield` without changing it till confirmed with `ENTER` 2020-09-23 20:46:36 +02:00
table.go Add Table.Sort, Table.SetSortFunc and Table.SetSortClicked 2020-09-01 15:44:43 -07:00
textview.go Add TextView.SetReindexBuffer 2020-09-03 19:23:56 -07:00
textview_test.go Reduce logging severity in TextView tests 2020-05-26 09:06:57 -07:00
treeview.go feat(treeview): Add `SetSelectedTextColor` and `SetSelectedBackgroundColor` 2020-09-23 18:25:22 +02:00
treeview_test.go Add comments to tests 2020-04-28 14:58:37 -07:00
util.go Update strikethrough implementation 2020-09-01 13:48:27 -07:00
util_test.go Upgrade tcell to v2 2020-08-30 08:37:17 -07:00

README.md

cview

GoDoc CI status Donate

Terminal-based user interface toolkit

This package is a fork of tview. See FORK.md for more information.

Demo

ssh cview.rocketnine.space -p 20000

Recording of presentation demo

Features

Available widgets:

  • Input forms (including input/password fields, drop-down selections, checkboxes, and buttons)
  • Navigable multi-color text views
  • Sophisticated navigable table views
  • Flexible tree views
  • Selectable lists with context menus
  • Grid, Flexbox and page layouts
  • Modal message windows
  • Horizontal and vertical progress bars
  • An application wrapper

Widgets may be customized and extended to suit any application.

Mouse support is available.

Installation

go get gitlab.com/tslocum/cview

Hello World

This basic example creates a box titled "Hello, World!" and displays it in your terminal:

package main

import (
	"gitlab.com/tslocum/cview"
)

func main() {
	box := cview.NewBox().SetBorder(true).SetTitle("Hello, world!")
	if err := cview.NewApplication().SetRoot(box, true).Run(); err != nil {
		panic(err)
	}
}

Examples are available via godoc and in the "demos" subdirectory.

For a presentation highlighting the features of this package, compile and run the program in the "demos/presentation" subdirectory.

Documentation

Package documentation is available via godoc.

An introduction tutorial is also available.

Dependencies

This package is based on github.com/gdamore/tcell (and its dependencies) and github.com/rivo/uniseg.

Support

CONTRIBUTING.md describes how to share issues, suggestions and patches (pull requests).