habittracker

Documentation

Index

• Variables
• type Animation
  • func (a *Animation) Complete() bool
  • func (a *Animation) New()
  • func (a *Animation) Selected() int
  • func (a *Animation) Update(s int, complete bool)
• type Model
  • func New(cli api.HabitsClient) *Model
  • func (m Model) Init() tea.Cmd
  • func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string

Variables

var AlertStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("62")).Render

AlertStyle provides styling for alert messages

var DocStyle = lipgloss.NewStyle().Margin(0, 2)

DocStyle styling for viewports

var ErrStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("#bd534b")).Render

ErrStyle provides styling for error messages

var HelpStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("241")).Render

HelpStyle styling for help context menu

var Keymap = keymap{
	Create: key.NewBinding(
		key.WithKeys("c"),
		key.WithHelp("c", "create"),
	),
	Enter: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "select"),
	),
	Rename: key.NewBinding(
		key.WithKeys("r"),
		key.WithHelp("r", "rename"),
	),
	Delete: key.NewBinding(
		key.WithKeys("d"),
		key.WithHelp("d", "delete"),
	),
	Back: key.NewBinding(
		key.WithKeys("esc"),
		key.WithHelp("esc", "back"),
	),
	Quit: key.NewBinding(
		key.WithKeys("ctrl+c", "q"),
		key.WithHelp("ctrl+c/q", "quit"),
	),
	Tab: key.NewBinding(
		key.WithKeys("tab", ""),
		key.WithHelp("tab", "tab"),
	),
	Filter: key.NewBinding(
		key.WithKeys("/"),
		key.WithHelp("f", "filter"),
	),
	Tick: key.NewBinding(
		key.WithKeys("t"),
		key.WithHelp("t", "tick"),
	),
}

Keymap reusable key mappings shared across models

Types

type Animation

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

func (*Animation) Complete

func (a *Animation) Complete() bool

func (*Animation) New

func (a *Animation) New()

func (*Animation) Selected

func (a *Animation) Selected() int

func (*Animation) Update

func (a *Animation) Update(s int, complete bool)

type Model

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

Model holds necessary charm models and more to bring the habit tracker to life!

func New

func New(cli api.HabitsClient) *Model

New creates a new Model.

func (Model) Init

func (m Model) Init() tea.Cmd

Init initializes Model behaviour. Here we start to tick to launch the progress bar animation

func (*Model) Update

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

Update captures the new tea.Msg and runs actions depending on the new message. msg can be a window resize, a keystroke, or a tick.

func (Model) View

func (m Model) View() string

View renders the view of the Model in a charming way.