tui

Documentation

Overview

Package tui wraps tview and tcell to create different layouts.

Available layouts are: Table, Preview and Text

Index

• func GetPager() string
• func IsDumbTerminal() bool
• func IsNotTTY() bool
• func PagerOut(out string) error
• type CopyFunc
• type CopyKeyFunc
• type MoveFunc
• type MoveHandlerFunc
• type Preview
  • func NewPreview(opts ...PreviewOption) *Preview
  • func (pv *Preview) Paint(pd []PreviewData) error
• type PreviewData
• type PreviewOption
  • func WithContentTableOpts(opts ...TableOption) PreviewOption
  • func WithInitialText(text string) PreviewOption
  • func WithPreviewFooterText(text string) PreviewOption
  • func WithSidebarSelectedFunc(fn SelectedFunc) PreviewOption
• type RefreshFunc
• type RefreshTableStateFunc
• type Screen
  • func NewScreen() *Screen
  • func (s *Screen) Paint(root tview.Primitive) error
• type SelectedFunc
• type Table
  • func NewTable(opts ...TableOption) *Table
  • func (t *Table) Paint(data TableData) error
• type TableData
  • func (td TableData) Get(r, c int) string
  • func (td TableData) GetIndex(key string) int
  • func (td TableData) Update(r, c int, val string)
• type TableOption
  • func WithCopyFunc(fn CopyFunc) TableOption
  • func WithCopyKeyFunc(fn CopyKeyFunc) TableOption
  • func WithFixedColumns(cols uint) TableOption
  • func WithMoveFunc(fn MoveFunc) TableOption
  • func WithRefreshFunc(fn RefreshFunc) TableOption
  • func WithSelectedFunc(fn SelectedFunc) TableOption
  • func WithTableFooterText(text string) TableOption
  • func WithTableHelpText(text string) TableOption
  • func WithTableStyle(style TableStyle) TableOption
  • func WithViewModeFunc(fn ViewModeFunc) TableOption
• type TableStyle
• type Text
  • func NewText() *Text
  • func (tv *Text) Render(td TextData) error
• type TextData
• type ViewModeFunc

Functions

func GetPager

func GetPager() string

GetPager returns configured pager.

func IsDumbTerminal

func IsDumbTerminal() bool

IsDumbTerminal checks TERM environment variable and returns true if it is set to dumb.

Dumb terminal indicates terminal with limited capability. It may not provide support for special character sequences, e.g., no handling of ANSI escape sequences.

func IsNotTTY

func IsNotTTY() bool

IsNotTTY returns true if the stdout file descriptor is not a TTY.

func PagerOut

func PagerOut(out string) error

PagerOut outputs to configured pager if possible.

Types

type CopyFunc

type CopyFunc func(row, column int, data interface{})

CopyFunc is fired when a user press 'c' character in the table cell.

type CopyKeyFunc

type CopyKeyFunc func(row, column int, data interface{})

CopyKeyFunc is fired when a user press 'CTRL+K' character in the table cell.

type MoveFunc

type MoveFunc func(row, col int) func() (key string, actions []string, handler MoveHandlerFunc, status string, refresh RefreshTableStateFunc)

MoveFunc is fired when a user press 'm' character in the table cell.

type MoveHandlerFunc

type MoveHandlerFunc func(state string) error

MoveHandlerFunc is a handler for move action.

type Preview

type Preview struct {
	// contains filtered or unexported fields
}

Preview is the preview layout.

It contains 2 tables internally, viz: sidebar and contents.

func NewPreview

func NewPreview(opts ...PreviewOption) *Preview

NewPreview constructs a new preview layout.

func (*Preview) Paint

func (pv *Preview) Paint(pd []PreviewData) error

Paint paints the preview layout.

type PreviewData

type PreviewData struct {
	Key      string
	Menu     string
	Contents func(string) interface{}
}

PreviewData is the data to be shown in preview layout.

type PreviewOption

type PreviewOption func(*Preview)

PreviewOption is a functional option that wraps preview properties.

func WithContentTableOpts

func WithContentTableOpts(opts ...TableOption) PreviewOption

WithContentTableOpts sets contents table options.

func WithInitialText

func WithInitialText(text string) PreviewOption

WithInitialText sets initial text that is displayed in the contents screen.

func WithPreviewFooterText

func WithPreviewFooterText(text string) PreviewOption

WithPreviewFooterText sets footer text that is displayed after the preview layout.

func WithSidebarSelectedFunc

func WithSidebarSelectedFunc(fn SelectedFunc) PreviewOption

WithSidebarSelectedFunc sets a function that is called when any option in sidebar is selected.

type RefreshFunc

type RefreshFunc func()

RefreshFunc is fired when a user press 'CTRL+R' or `F5` character in the table.

type RefreshTableStateFunc

type RefreshTableStateFunc func(row, col int, val string)

RefreshTableStateFunc is used to refresh the table state.

type Screen

type Screen struct {
	*tview.Application
}

Screen is a shell screen.

func NewScreen

func NewScreen() *Screen

NewScreen creates a new screen.

func (*Screen) Paint

func (s *Screen) Paint(root tview.Primitive) error

Paint paints UI to the screen.

type SelectedFunc

type SelectedFunc func(row, column int, data interface{})

SelectedFunc is fired when a user press enter key in the table cell.

type Table

type Table struct {
	// contains filtered or unexported fields
}

Table is a table layout.

func NewTable

func NewTable(opts ...TableOption) *Table

NewTable constructs a new table layout.

func (*Table) Paint

func (t *Table) Paint(data TableData) error

Paint paints the table layout. First row is treated as a table header.

type TableData

type TableData [][]string

TableData is the data to be displayed in a table.

func (TableData) Get

func (td TableData) Get(r, c int) string

Get returns the value of the cell at the given row and column.

func (TableData) GetIndex

func (td TableData) GetIndex(key string) int

GetIndex returns the index of the specified column.

func (TableData) Update

func (td TableData) Update(r, c int, val string)

Update updates the data at given row and column.

type TableOption

type TableOption func(*Table)

TableOption is a functional option to wrap table properties.

func WithCopyFunc

func WithCopyFunc(fn CopyFunc) TableOption

WithCopyFunc sets a func that is triggered when a user press 'c'.

func WithCopyKeyFunc

func WithCopyKeyFunc(fn CopyKeyFunc) TableOption

WithCopyKeyFunc sets a func that is triggered when a user press 'CTRL+K'.

func WithFixedColumns

func WithFixedColumns(cols uint) TableOption

WithFixedColumns sets the number of columns that are locked (do not scroll right).

func WithMoveFunc

func WithMoveFunc(fn MoveFunc) TableOption

WithMoveFunc sets a func that is triggered when an action button is pressed.

func WithRefreshFunc

func WithRefreshFunc(fn RefreshFunc) TableOption

WithRefreshFunc sets a func that is triggered when a user press 'CTRL+R' or 'F5'.

func WithSelectedFunc

func WithSelectedFunc(fn SelectedFunc) TableOption

WithSelectedFunc sets a func that is triggered when table row is selected.

func WithTableFooterText

func WithTableFooterText(text string) TableOption

WithTableFooterText sets footer text that is displayed after the table.

func WithTableHelpText

func WithTableHelpText(text string) TableOption

WithTableHelpText sets the help text for the view.

func WithTableStyle

func WithTableStyle(style TableStyle) TableOption

WithTableStyle sets the style of the table.

func WithViewModeFunc

func WithViewModeFunc(fn ViewModeFunc) TableOption

WithViewModeFunc sets a func that is triggered when a user press 'v'.

type TableStyle

type TableStyle struct {
	SelectionBackground string
	SelectionForeground string
	SelectionTextIsBold bool
}

TableStyle sets the style of the table.

type Text

type Text struct {
	// contains filtered or unexported fields
}

Text is the text view layout.

func NewText

func NewText() *Text

NewText constructs a new text view layout.

func (*Text) Render

func (tv *Text) Render(td TextData) error

Render renders the text layout.

type TextData

type TextData string

TextData is the data to be shown in text layout.

type ViewModeFunc

type ViewModeFunc func(row, col int, data interface{}) (func() interface{}, func(data interface{}) (string, error))

ViewModeFunc sets view mode handler func which gets triggered when a user press 'v'.