ui

Documentation

Index

• Constants
• type Containerized
  • func NewContainerized(focused string, children []string) *Containerized
  • func (c *Containerized) Children() []string
  • func (c *Containerized) FocusChild(child string)
  • func (c *Containerized) Focused() string
  • func (c *Containerized) Next() string
• type ContainerizedInterface
• type Focusable
  • func (f *Focusable) Blur()
  • func (f *Focusable) Focus()
  • func (f *Focusable) IsFocused() bool
• type FocusableInterface
• type Notifier
• type Refreshable
• type Resizable
  • func (r *Resizable) Resize(width, height int, border lipgloss.Border)
• type ResizeInterface
• type Visible
  • func NewVisible(visible bool) Visible
  • func (v *Visible) Hide()
  • func (v *Visible) IsVisible() bool
  • func (v *Visible) Show()
  • func (v *Visible) Toggle()
• type VisibleInterface

Constants

const DetailModel = "detail"

const PrimaryModel = "primaryModel"

PrimaryModel is a list of task models.

const TasksTableModel = "tasks-table"

Types

type Containerized

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

func NewContainerized

func NewContainerized(focused string, children []string) *Containerized

func (*Containerized) Children

func (c *Containerized) Children() []string

func (*Containerized) FocusChild

func (c *Containerized) FocusChild(child string)

func (*Containerized) Focused

func (c *Containerized) Focused() string

func (*Containerized) Next

func (c *Containerized) Next() string

type ContainerizedInterface

type ContainerizedInterface interface {
	Focused() string
	Next() string
	FocusChild(string)
	Children() []string
}

ContainerizedInterface is a component that can contain other components.

type Focusable

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

func (*Focusable) Blur

func (f *Focusable) Blur()

func (*Focusable) Focus

func (f *Focusable) Focus()

func (*Focusable) IsFocused

func (f *Focusable) IsFocused() bool

type FocusableInterface

type FocusableInterface interface {
	// TODO add return tea.Cmd
	Focus()
	// TODO add return tea.Cmd
	Blur()
}

type Notifier

type Notifier interface {
	Info(msg string)
	Warn(msg string)
	Error(msg string)
}

Notifier is a component that can notify to the parent component.

type Refreshable

type Refreshable interface {
	FetchTasks(isHardRefresh bool) tea.Cmd
}

type Resizable

type Resizable struct {
	Height   int
	Width    int
	Viewport viewport.Model
}

Resizable managed the size of the component, Viewpoint is inner viewport of the component, which is used to render the content Viewport' size is the size of the component minus the border size.

func (*Resizable) Resize

func (r *Resizable) Resize(width, height int, border lipgloss.Border)

type ResizeInterface

type ResizeInterface interface {
	Resize(width, height int)
}

type Visible

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

func NewVisible

func NewVisible(visible bool) Visible

func (*Visible) Hide

func (v *Visible) Hide()

func (*Visible) IsVisible

func (v *Visible) IsVisible() bool

func (*Visible) Show

func (v *Visible) Show()

func (*Visible) Toggle

func (v *Visible) Toggle()

type VisibleInterface

type VisibleInterface interface {
	IsVisible() bool
	Show()
	Hide()
}

VisibleInterface is a component that can be shown or hidden.