overview

Documentation

Index

• Variables
• type ChosenCategoryMsg
• type Keymap
  • func (m *Keymap) SetEnabled(enabled bool)
• type Model
  • func New(colors *theme.Colors, width, height int, title string, fetcher backend.Fetcher) Model
  • func (m Model) FullHelp() [][]key.Binding
  • func (m Model) Init() tea.Cmd
  • func (m Model) SetSize(width, height int) tab.Tab
  • func (m Model) ShortHelp() []key.Binding
  • func (m Model) Style() tab.Style
  • func (m Model) Title() string
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type Popup
  • func NewPopup(colors *theme.Colors, oldName, oldDesc string) Popup
  • func (p Popup) GetSize() (width, height int)
  • func (p Popup) Init() tea.Cmd
  • func (p Popup) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (p Popup) View() string

Variables

var DefaultKeymap = Keymap{
	NewCategory: key.NewBinding(
		key.WithKeys("n", "ctrl+n"),
		key.WithHelp("n/ctrl+n", "New"),
	),
	EditCategory: key.NewBinding(
		key.WithKeys("e", "ctrl+e"),
		key.WithHelp("e/ctrl+e", "Edit"),
	),
	DeleteCategory: key.NewBinding(
		key.WithKeys("d", "ctrl+d"),
		key.WithHelp("d/ctrl+d", "Delete"),
	),
}

DefaultKeymap contains the default key bindings for this tab

Types

type ChosenCategoryMsg

type ChosenCategoryMsg struct {
	Name    string
	Desc    string
	OldName string
	IsEdit  bool
}

ChosenCategoryMsg is the message displayed when a category is successfully chosen.

type Keymap

type Keymap struct {
	NewCategory    key.Binding
	EditCategory   key.Binding
	DeleteCategory key.Binding
}

Keymap contains the key bindings for this tab

func (*Keymap) SetEnabled

func (m *Keymap) SetEnabled(enabled bool)

SetEnabled allows to disable/enable shortcuts

type Model

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

Model contains the state of this tab

func New

func New(colors *theme.Colors, width, height int, title string, fetcher backend.Fetcher) Model

New creates a new welcome tab with sensible defaults

func (Model) FullHelp

func (m Model) FullHelp() [][]key.Binding

FullHelp returns the full help for this tab

func (Model) Init

func (m Model) Init() tea.Cmd

Init initializes the tab

func (Model) SetSize

func (m Model) SetSize(width, height int) tab.Tab

SetSize sets the dimensions of the tab

func (Model) ShortHelp

func (m Model) ShortHelp() []key.Binding

ShortHelp returns the short help for this tab

func (Model) Style

func (m Model) Style() tab.Style

Style returns the style of the tab

func (Model) Title

func (m Model) Title() string

Title returns the title of the tab

func (Model) Update

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

Update updates the variables of the tab

func (Model) View

func (m Model) View() string

View returns the view for the tab

type Popup

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

Popup is the category popup where a user can create a category.

func NewPopup

func NewPopup(colors *theme.Colors, oldName, oldDesc string) Popup

NewPopup creates a new popup window in which the user can choose a new category.

func (Popup) GetSize

func (p Popup) GetSize() (width, height int)

GetSize returns the size of the popup.

func (Popup) Init

func (p Popup) Init() tea.Cmd

Init the popup window.

func (Popup) Update

func (p Popup) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update the popup window.

func (Popup) View

func (p Popup) View() string

View renders the popup window.