mirror of https://github.com/mum4k/termdash.git
153 lines
5.2 KiB
Markdown
153 lines
5.2 KiB
Markdown
[](https://godoc.org/github.com/mum4k/termdash)
|
|
[](https://travis-ci.org/mum4k/termdash)
|
|
[](https://coveralls.io/github/mum4k/termdash?branch=master)
|
|
[](https://goreportcard.com/report/github.com/mum4k/termdash)
|
|
[](https://github.com/mum4k/termdash/blob/master/LICENSE)
|
|
[](https://github.com/avelino/awesome-go)
|
|
|
|
# termdash
|
|
|
|
[<img src="./images/termdashdemo.gif" alt="termdashdemo" type="image/gif">](termdashdemo/termdashdemo.go)
|
|
|
|
This project implements a cross-platform customizable terminal based dashboard.
|
|
The feature set is inspired by the
|
|
[gizak/termui](http://github.com/gizak/termui) project, which in turn was
|
|
inspired by a javascript based
|
|
[yaronn/blessed-contrib](http://github.com/yaronn/blessed-contrib).
|
|
|
|
This rewrite focuses on code readability, maintainability and testability, see
|
|
the [design goals](doc/design_goals.md). It aims to achieve the following
|
|
[requirements](doc/requirements.md). See the [high-level design](doc/hld.md)
|
|
for more details.
|
|
|
|
# Current feature set
|
|
|
|
- Full support for terminal window resizing throughout the infrastructure.
|
|
- Customizable layout, widget placement, borders, colors, etc.
|
|
- Focusable containers and widgets.
|
|
- Processing of keyboard and mouse events.
|
|
- Periodic and event driven screen redraw.
|
|
- A library of widgets, see below.
|
|
- UTF-8 for all text elements.
|
|
- Drawing primitives (Go functions) for widget development with character and
|
|
sub-character resolution.
|
|
|
|
See the [changelog](CHANGELOG.md) for more details.
|
|
|
|
# Installation
|
|
|
|
To install this library, run the following:
|
|
|
|
```
|
|
go get -u github.com/mum4k/termdash
|
|
|
|
```
|
|
|
|
# Usage
|
|
|
|
The usage of most of these elements is demonstrated in
|
|
[termdashdemo.go](termdashdemo/termdashdemo.go). To execute the demo:
|
|
|
|
|
|
```
|
|
go run github.com/mum4k/termdash/termdashdemo/termdashdemo.go
|
|
```
|
|
|
|
# Documentation
|
|
|
|
Code documentation can be viewed in
|
|
[godoc](https://godoc.org/github.com/mum4k/termdash).
|
|
|
|
Project documentation is available in the [doc](doc/) directory.
|
|
|
|
## Implemented Widgets
|
|
|
|
### The Gauge
|
|
|
|
Displays the progress of an operation. Run the
|
|
[gaugedemo](widgets/gauge/gaugedemo/gaugedemo.go).
|
|
|
|
```go
|
|
go run github.com/mum4k/termdash/widgets/gauge/gaugedemo/gaugedemo.go
|
|
```
|
|
|
|
[<img src="./images/gaugedemo.gif" alt="gaugedemo" type="image/gif">](widgets/gauge/gaugedemo/gaugedemo.go)
|
|
|
|
### The Donut
|
|
|
|
Visualizes progress of an operation as a partial or a complete donut. Run the
|
|
[donutdemo](widgets/donut/donutdemo/donutdemo.go).
|
|
|
|
```go
|
|
go run github.com/mum4k/termdash/widgets/donut/donutdemo/donutdemo.go
|
|
```
|
|
|
|
[<img src="./images/donutdemo.gif" alt="donutdemo" type="image/gif">](widgets/donut/donutdemo/donutdemo.go)
|
|
|
|
### The Text
|
|
|
|
Displays text content, supports trimming and scrolling of content. Run the
|
|
[textdemo](widgets/text/textdemo/textdemo.go).
|
|
|
|
```go
|
|
go run github.com/mum4k/termdash/widgets/text/textdemo/textdemo.go
|
|
```
|
|
|
|
[<img src="./images/textdemo.gif" alt="textdemo" type="image/gif">](widgets/text/textdemo/textdemo.go)
|
|
|
|
### The SparkLine
|
|
|
|
Draws a graph showing a series of values as vertical bars. The bars can have
|
|
sub-cell height. Run the
|
|
[sparklinedemo](widgets/sparkline/sparklinedemo/sparklinedemo.go).
|
|
|
|
```go
|
|
go run github.com/mum4k/termdash/widgets/sparkline/sparklinedemo/sparklinedemo.go
|
|
```
|
|
|
|
[<img src="./images/sparklinedemo.gif" alt="sparklinedemo" type="image/gif">](widgets/sparkline/sparklinedemo/sparklinedemo.go)
|
|
|
|
### The BarChart
|
|
|
|
Displays multiple bars showing relative ratios of values. Run the
|
|
[barchartdemo](widgets/barchart/barchartdemo/barchartdemo.go).
|
|
|
|
```go
|
|
go run github.com/mum4k/termdash/widgets/barchart/barchartdemo/barchartdemo.go
|
|
```
|
|
|
|
[<img src="./images/barchartdemo.gif" alt="barchartdemo" type="image/gif">](widgets/barchart/barchartdemo/barchartdemo.go)
|
|
|
|
### The LineChart
|
|
|
|
Displays series of values on a line chart. Run the
|
|
[linechartdemo](widgets/linechart/linechartdemo/linechartdemo.go).
|
|
|
|
```go
|
|
go run github.com/mum4k/termdash/widgets/linechart/linechartdemo/linechartdemo.go
|
|
```
|
|
|
|
[<img src="./images/linechartdemo.gif" alt="linechartdemo" type="image/gif">](widgets/linechart/linechartdemo/linechartdemo.go)
|
|
|
|
# Contributing
|
|
|
|
If you are willing to contribute, improve the infrastructure or develop a
|
|
widget, first of all Thank You! Your help is appreciated.
|
|
|
|
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines related
|
|
to the Google's CLA, and code review requirements.
|
|
|
|
As stated above the primary goal of this project is to develop readable, well
|
|
designed code, the functionality and efficiency come second. This is achieved
|
|
through detailed code reviews, design discussions and following of the [design
|
|
guidelines](doc/design_guidelines.md). Please familiarize yourself with these
|
|
before contributing.
|
|
|
|
If you're developing a new widget, please see the [widget
|
|
development](doc/widget_development.md) section.
|
|
|
|
|
|
## Disclaimer
|
|
|
|
This is not an official Google product.
|