ui

Documentation

Index

• Constants
• Variables
• func GenerateData(db *sql.DB, numDays, numTasks uint8) error
• func RenderReport(db *sql.DB, style Style, writer io.Writer, plain bool, period string, agg bool, ...) error
• func RenderStats(db *sql.DB, style Style, writer io.Writer, plain bool, period string, ...) error
• func RenderTaskLog(db *sql.DB, style Style, writer io.Writer, plain bool, period string, ...) error
• func RenderUI(db *sql.DB, style Style) error
• func ShowActiveTask(db *sql.DB, writer io.Writer, template string) error
• type Model
  • func InitialModel(db *sql.DB, style Style) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type Style
  • func NewStyle(theme Theme) Style
• type Theme
  • func DefaultTheme() Theme
  • func LoadTheme(themeJSON []byte) (Theme, error)

Constants

const (
	ActiveTaskPlaceholder     = "{{task}}"
	ActiveTaskTimePlaceholder = "{{time}}"
)

Variables

var (
	ErrThemeFileHasInvalidSchema = errors.New("theme file's schema is incorrect")
	ErrThemeColorsAreInvalid     = errors.New("invalid colors provided")
)

Functions

func GenerateData

func GenerateData(db *sql.DB, numDays, numTasks uint8) error

func RenderReport

func RenderReport(db *sql.DB, style Style, writer io.Writer, plain bool, period string, agg bool, interactive bool) error

func RenderStats

func RenderStats(db *sql.DB, style Style, writer io.Writer, plain bool, period string, interactive bool) error

func RenderTaskLog

func RenderTaskLog(db *sql.DB, style Style, writer io.Writer, plain bool, period string, interactive bool) error

func RenderUI

func RenderUI(db *sql.DB, style Style) error

func ShowActiveTask

func ShowActiveTask(db *sql.DB, writer io.Writer, template string) error

Types

type Model

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

func InitialModel

func InitialModel(db *sql.DB, style Style) Model

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() string

type Style

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

func NewStyle

func NewStyle(theme Theme) Style

type Theme

type Theme struct {
	ActiveTask              string   `json:"activeTask,omitempty"`
	ActiveTaskBeginTime     string   `json:"activeTaskBeginTime,omitempty"`
	ActiveTasks             string   `json:"activeTasks,omitempty"`
	FormContext             string   `json:"formContext,omitempty"`
	FormFieldName           string   `json:"formFieldName,omitempty"`
	FormHelp                string   `json:"formHelp,omitempty"`
	HelpMsg                 string   `json:"helpMsg,omitempty"`
	HelpPrimary             string   `json:"helpPrimary,omitempty"`
	HelpSecondary           string   `json:"helpSecondary,omitempty"`
	InactiveTasks           string   `json:"inactiveTasks,omitempty"`
	InitialHelpMsg          string   `json:"initialHelpMsg,omitempty"`
	ListItemDesc            string   `json:"listItemDesc,omitempty"`
	ListItemTitle           string   `json:"listItemTitle,omitempty"`
	RecordsBorder           string   `json:"recordsBorder,omitempty"`
	RecordsDateRange        string   `json:"recordsDateRange,omitempty"`
	RecordsFooter           string   `json:"recordsFooter,omitempty"`
	RecordsHeader           string   `json:"recordsHeader,omitempty"`
	RecordsHelp             string   `json:"recordsHelp,omitempty"`
	TaskLogDetailsViewTitle string   `json:"taskLogDetails,omitempty"`
	TaskEntry               string   `json:"taskEntry,omitempty"`
	TaskLogEntry            string   `json:"taskLogEntry,omitempty"`
	TaskLogList             string   `json:"taskLogList,omitempty"`
	Tasks                   []string `json:"tasks,omitempty"`
	TitleForeground         string   `json:"titleForeground,omitempty"`
	ToolName                string   `json:"toolName,omitempty"`
	Tracking                string   `json:"tracking,omitempty"`
}

func DefaultTheme

func DefaultTheme() Theme

func LoadTheme

func LoadTheme(themeJSON []byte) (Theme, error)