widgets

Documentation

Index

• Variables
• func Print(screen tcell.Screen, x int, y int, style tcell.Style, text string)
• type Align
• type Block
  • func NewBlock() *Block
  • func (w *Block) Draw(screen tcell.Screen)
  • func (b *Block) InnerSize() (int, int, int, int)
  • func (w *Block) Key(event *tcell.EventKey)
  • func (w *Block) SetSize(x int, y int, width int, height int)
  • func (w *Block) Size() (int, int, int, int)
• type Borders
• type List
  • func NewList() *List
  • func (l *List) Append(item ListItem)
  • func (w *List) Draw(screen tcell.Screen)
  • func (w *List) Key(event *tcell.EventKey)
  • func (l *List) Remove(item ListItem)
• type ListItem
• type Widget

Variables

var LineBorders = Borders{
	Top:         tcell.RuneHLine,
	Bottom:      tcell.RuneHLine,
	Left:        tcell.RuneVLine,
	Right:       tcell.RuneVLine,
	TopLeft:     tcell.RuneULCorner,
	TopRight:    tcell.RuneURCorner,
	BottomLeft:  tcell.RuneLLCorner,
	BottomRight: tcell.RuneLRCorner,
}

var RoundBorders = Borders{
	Top:         LineBorders.Top,
	Bottom:      LineBorders.Bottom,
	Left:        LineBorders.Left,
	Right:       LineBorders.Right,
	TopLeft:     '╭',
	TopRight:    '╮',
	BottomLeft:  '╰',
	BottomRight: '╯',
}

Functions

func Print

func Print(screen tcell.Screen, x int, y int, style tcell.Style, text string)

Types

type Align

type Align int

const (
	AlignLeft Align = iota
	AlignCenter
	AlignRight
)

type Block

type Block struct {
	Title      string
	TitleAlign Align
	TitleStyle tcell.Style

	Border      bool
	Borders     Borders
	BorderStyle tcell.Style
	// contains filtered or unexported fields
}

Block represents a frame with optional and customizable elements such as borders and a title.

func NewBlock

func NewBlock() *Block

func (*Block) Draw

func (w *Block) Draw(screen tcell.Screen)

func (*Block) InnerSize

func (b *Block) InnerSize() (int, int, int, int)

func (*Block) Key

func (w *Block) Key(event *tcell.EventKey)

func (*Block) SetSize

func (w *Block) SetSize(x int, y int, width int, height int)

func (*Block) Size

func (w *Block) Size() (int, int, int, int)

type Borders

type Borders struct {
	Top         rune
	Bottom      rune
	Left        rune
	Right       rune
	TopLeft     rune
	TopRight    rune
	BottomLeft  rune
	BottomRight rune
}

type List

type List struct {
	*Block
	ItemStyle         tcell.Style
	SelectedItemStyle tcell.Style
	// contains filtered or unexported fields
}

List represents a vertical list of selectable items.

func NewList

func NewList() *List

func (*List) Append

func (l *List) Append(item ListItem)

Append appends an item to the list.

func (*List) Draw

func (w *List) Draw(screen tcell.Screen)

func (*List) Key

func (w *List) Key(event *tcell.EventKey)

func (*List) Remove

func (l *List) Remove(item ListItem)

Remove removes an item from the list.

type ListItem

type ListItem interface {
	String() string
}

type Widget

type Widget interface {
	Size() (x int, y int, width int, height int)
	SetSize(x int, y int, width int, height int)

	Key(event *tcell.EventKey)
	Draw(screen tcell.Screen)
}

Widget is the base interface for all widgets.