Popularity
9.7
Stable
Activity
0.0
Declining
12,505
287
773

Programming language: Go
License: MIT License
Latest version: v3.1.0

termui alternatives and similar packages

Based on the "Advanced Console UIs" category.
Alternatively, view termui alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of termui or a related project?

Add another 'Advanced Console UIs' Package
TestGPT | Generating meaningful tests for busy devs
sponsored codium.ai

Popular Comparisons

ONLYOFFICE Docs — document collaboration in your environment
sponsored www.onlyoffice.com

README

termui

[](./_examples/demo.go)

termui is a cross-platform and fully-customizable terminal dashboard and widget library built on top of termbox-go. It is inspired by blessed-contrib and tui-rs and written purely in Go.

Features

  • Several premade widgets for common use cases
  • Easily create custom widgets
  • Position widgets either in a relative grid or with absolute coordinates
  • Keyboard, mouse, and terminal resizing events
  • Colors and styling

Installation

Go modules

It is not necessary to go get termui, since Go will automatically manage any imported dependencies for you. Do note that you have to include /v3 in the import statements as shown in the 'Hello World' example below.

Dep

Add with dep ensure -add github.com/gizak/termui. With Dep, /v3 should not be included in the import statements.

Hello World

package main

import (
    "log"

    ui "github.com/gizak/termui/v3"
    "github.com/gizak/termui/v3/widgets"
)

func main() {
    if err := ui.Init(); err != nil {
        log.Fatalf("failed to initialize termui: %v", err)
    }
    defer ui.Close()

    p := widgets.NewParagraph()
    p.Text = "Hello World!"
    p.SetRect(0, 0, 25, 5)

    ui.Render(p)

    for e := range ui.PollEvents() {
        if e.Type == ui.KeyboardEvent {
            break
        }
    }
}

Widgets

  • [BarChart](./_examples/barchart.go)
  • [Canvas](./_examples/canvas.go) (for drawing braille dots)
  • [Gauge](./_examples/gauge.go)
  • [Image](./_examples/image.go)
  • [List](./_examples/list.go)
  • [Tree](./_examples/tree.go)
  • [Paragraph](./_examples/paragraph.go)
  • [PieChart](./_examples/piechart.go)
  • [Plot](./_examples/plot.go) (for scatterplots and linecharts)
  • [Sparkline](./_examples/sparkline.go)
  • [StackedBarChart](./_examples/stacked_barchart.go)
  • [Table](./_examples/table.go)
  • [Tabs](./_examples/tabs.go)

Run an example with go run _examples/{example}.go or run each example consecutively with make run-examples.

Documentation

Uses

Related Works

License

MIT


*Note that all licence references and agreements mentioned in the termui README section above are relevant to that project's source code only.