tui

Documentation

Index

• Constants
• Variables
• func Browse(ctx context.Context, opts BrowseOptions) error
• func ControlsHelp() string
• func Run(ctx context.Context, opts Options) error
• type BrowseOptions
• type Item
• type LayoutPreset
• type Options
• type Row
  • func (r Row) Item() Item
  • func (r Row) ItemForLayout(layout LayoutPreset) Item

Constants

const (
	SourceLocal  = "local"
	SourceRemote = "remote"
)

Variables

var ErrNotTerminal = errors.New("terminal UI requires an interactive terminal")

Functions

func Browse

func Browse(ctx context.Context, opts BrowseOptions) error

func ControlsHelp

func ControlsHelp() string

func Run

func Run(ctx context.Context, opts Options) error

Types

type BrowseOptions

type BrowseOptions struct {
	AppName        string
	Title          string
	EmptyMessage   string
	Rows           []Row
	Refresh        func(context.Context) ([]Row, error)
	RefreshEvery   time.Duration
	JSON           bool
	Layout         LayoutPreset
	SourceKind     string
	SourceLocation string
	Stdin          io.Reader
	Stdout         io.Writer
}

type Item

type Item struct {
	Title     string            `json:"title"`
	Subtitle  string            `json:"subtitle,omitempty"`
	Text      string            `json:"text,omitempty"`
	Detail    string            `json:"detail,omitempty"`
	Tags      []string          `json:"tags,omitempty"`
	Depth     int               `json:"depth,omitempty"`
	Source    string            `json:"source,omitempty"`
	Kind      string            `json:"kind,omitempty"`
	ID        string            `json:"id,omitempty"`
	ParentID  string            `json:"parent_id,omitempty"`
	Scope     string            `json:"scope,omitempty"`
	Container string            `json:"container,omitempty"`
	Author    string            `json:"author,omitempty"`
	URL       string            `json:"url,omitempty"`
	CreatedAt string            `json:"created_at,omitempty"`
	UpdatedAt string            `json:"updated_at,omitempty"`
	Fields    map[string]string `json:"fields,omitempty"`
}

type LayoutPreset

type LayoutPreset string

const (
	LayoutAuto     LayoutPreset = ""
	LayoutList     LayoutPreset = "list"
	LayoutChat     LayoutPreset = "chat"
	LayoutDocument LayoutPreset = "document"
)

type Options

type Options struct {
	Title          string
	EmptyMessage   string
	Items          []Item
	Refresh        func(context.Context) ([]Item, error)
	RefreshEvery   time.Duration
	Layout         LayoutPreset
	SourceKind     string
	SourceLocation string
	Stdin          io.Reader
	Stdout         io.Writer
}

type Row

type Row struct {
	Source    string            `json:"source,omitempty"`
	Kind      string            `json:"kind"`
	ID        string            `json:"id,omitempty"`
	ParentID  string            `json:"parent_id,omitempty"`
	Depth     int               `json:"depth,omitempty"`
	Scope     string            `json:"scope,omitempty"`
	Container string            `json:"container,omitempty"`
	Author    string            `json:"author,omitempty"`
	Title     string            `json:"title"`
	Text      string            `json:"text,omitempty"`
	Detail    string            `json:"detail,omitempty"`
	URL       string            `json:"url,omitempty"`
	CreatedAt string            `json:"created_at,omitempty"`
	UpdatedAt string            `json:"updated_at,omitempty"`
	Tags      []string          `json:"tags,omitempty"`
	Fields    map[string]string `json:"fields,omitempty"`
}

func (Row) Item

func (r Row) Item() Item

func (Row) ItemForLayout

func (r Row) ItemForLayout(layout LayoutPreset) Item