ext

Documentation

Index

• func NewAskModal(question string, submit, cancel func()) *tview.Modal
• func NewErrorModal(cancel func()) *tview.Modal
• func NewModal() *tview.Modal
• func WrapIntoModal(primitive tview.Primitive, width, height int) *tview.Flex
• type DateField
  • func NewDateField() *DateField
  • func (d *DateField) Draw(screen tcell.Screen)
  • func (d *DateField) GetFieldHeight() int
  • func (d *DateField) GetFieldWidth() int
  • func (d *DateField) GetLabel() string
  • func (d *DateField) GetTextDate() string
  • func (d *DateField) HasFocus() bool
  • func (d *DateField) InputHandler() func(event *tcell.EventKey, setFocus func(p tview.Primitive))
  • func (d *DateField) SetFinishedFunc(handler func(key tcell.Key)) tview.FormItem
  • func (d *DateField) SetFormAttributes(labelWidth int, labelColor, bgColor, fieldTextColor, fieldBgColor tcell.Color) tview.FormItem
  • func (d *DateField) SetLabel(label string) *DateField
  • func (d *DateField) SetTextDate(text string) *DateField
• type Form
  • func NewForm(form *tview.Form, dataProvider FormDataProvider) *Form
  • func (f *Form) GetFields() map[string]string
  • func (f *Form) SetFields(m map[string]string)
• type FormDataProvider
• type Table
  • func NewTable(cols []string, dataProvider TableDataProvider) *Table
  • func (t *Table) GetSelectedRef() map[string]string
  • func (t *Table) Refresh() *Table
  • func (t *Table) SetOrder(orderCol string, reversed bool) *Table
• type TableDataProvider

Functions

func NewAskModal

func NewAskModal(question string, submit, cancel func()) *tview.Modal

NewAskModal returns new tview.Modal with text and "Yes/No" buttons. Use submit and cancel args to set actions on buttons click.

func NewErrorModal

func NewErrorModal(cancel func()) *tview.Modal

NewErrorModal returns new tview.Modal with "okay" button. Use cancel variable to set action button.

func NewModal

func NewModal() *tview.Modal

NewModal returns new tview.Modal with default Form styles.

func WrapIntoModal

func WrapIntoModal(primitive tview.Primitive, width, height int) *tview.Flex

WrapIntoModal wraps primitive into modal with specified width and height.

Types

type DateField

type DateField struct {
	*tview.Box
	// contains filtered or unexported fields
}

func NewDateField

func NewDateField() *DateField

func (*DateField) Draw

func (d *DateField) Draw(screen tcell.Screen)

Draw draws this primitive onto the screen.

func (*DateField) GetFieldHeight

func (d *DateField) GetFieldHeight() int

GetFieldHeight returns this primitive's field height.

func (*DateField) GetFieldWidth

func (d *DateField) GetFieldWidth() int

GetFieldWidth returns this primitive's field screen width.

func (*DateField) GetLabel

func (d *DateField) GetLabel() string

GetLabel returns the text to be displayed before the input area.

func (*DateField) GetTextDate

func (d *DateField) GetTextDate() string

GetText returns the current text of the date field.

func (*DateField) HasFocus

func (d *DateField) HasFocus() bool

HasFocus returns whether or not this primitive has focus.

func (*DateField) InputHandler

func (d *DateField) InputHandler() func(event *tcell.EventKey, setFocus func(p tview.Primitive))

InputHandler returns the handler for this primitive.

func (*DateField) SetFinishedFunc

func (d *DateField) SetFinishedFunc(handler func(key tcell.Key)) tview.FormItem

SetFinishedFunc sets a callback invoked when the user leaves this form item.

func (*DateField) SetFormAttributes

func (d *DateField) SetFormAttributes(labelWidth int, labelColor, bgColor, fieldTextColor, fieldBgColor tcell.Color) tview.FormItem

SetFormAttributes sets attributes shared by all form items.

func (*DateField) SetLabel

func (d *DateField) SetLabel(label string) *DateField

SetLabel sets the text to be displayed before the input area.

func (*DateField) SetTextDate

func (d *DateField) SetTextDate(text string) *DateField

SetText sets the current text of the input field.

type Form

type Form struct {
	*tview.Form
	// contains filtered or unexported fields
}

Form an extension for tview.Form. It used to avoid duplication while setting and getting field values.

func NewForm

func NewForm(form *tview.Form, dataProvider FormDataProvider) *Form

NewForm returns new extended Form.

func (*Form) GetFields

func (f *Form) GetFields() map[string]string

GetFields returns fields values as map of strings where the key is field label.

func (*Form) SetFields

func (f *Form) SetFields(m map[string]string)

SetFields sets fields value from map where key is field label and value is a value.

type FormDataProvider

type FormDataProvider interface {
	GetDropDownOptions(label string) []string
}

FormDataProvider an interface for getting options for dropdown fields.

type Table

type Table struct {
	*tview.Table
	// contains filtered or unexported fields
}

Table an extensioun for tview.Table.

func NewTable

func NewTable(cols []string, dataProvider TableDataProvider) *Table

NewTable returns new extended Table.

func (*Table) GetSelectedRef

func (t *Table) GetSelectedRef() map[string]string

GetSelectedRef returns a reference map[string]string of current selected row.

func (*Table) Refresh

func (t *Table) Refresh() *Table

Refresh refreshes the data and redraws the table.

func (*Table) SetOrder

func (t *Table) SetOrder(orderCol string, reversed bool) *Table

SetOrder sets the order of displayed table data.

type TableDataProvider

type TableDataProvider interface {
	GetAll() []map[string]string
}

TableDataProvider an interface for table data population.