decks

Documentation

Index

• func AddDeck(name string) tea.Cmd
• func SelectDeck(selectedDeck *ListItem) tea.Cmd
• func UpdateDeck(updatedName string) tea.Cmd
• type AddDeckMsg
• type DeckSelectedMsg
• type ListItem
  • func (i ListItem) DeckName() string
  • func (i ListItem) Description() string
  • func (i ListItem) FilterValue() string
  • func (i ListItem) GetDBItem() flashcard.Deck
  • func (i ListItem) Title() string
• type Model
  • func New(deckManager flashcard.DeckManager) *Model
  • func (m *Model) Focus()
  • func (m *Model) GetHeight() int
  • func (m *Model) GetWidth() int
  • func (m *Model) Init() tea.Cmd
  • func (m *Model) IsTyping() bool
  • func (m *Model) SelectedDeck() (int, *ListItem)
  • func (m *Model) SetHeight(height int)
  • func (m *Model) SetWidth(width int)
  • func (m *Model) Unfocus()
  • func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *Model) View() string
• type NoDeckSelectedMsg
• type UpdateDeckMsg

Functions

func AddDeck

func AddDeck(name string) tea.Cmd

func SelectDeck

func SelectDeck(selectedDeck *ListItem) tea.Cmd

func UpdateDeck

func UpdateDeck(updatedName string) tea.Cmd

Types

type AddDeckMsg

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

type DeckSelectedMsg

type DeckSelectedMsg struct {
	DeckItem ListItem
}

type ListItem

type ListItem struct {
	DBItem flashcard.Deck
}

ListItem to represent deck in decks list.

It contains name of deck as Title and has no Description.

Also it keeps dbItem that helps to manipulatie corresponding deck object in repository.

func (ListItem) DeckName

func (i ListItem) DeckName() string

func (ListItem) Description

func (i ListItem) Description() string

Description that doesn't exist.

func (ListItem) FilterValue

func (i ListItem) FilterValue() string

FilterValue by deck's name.

func (ListItem) GetDBItem

func (i ListItem) GetDBItem() flashcard.Deck

GetDBItem to operate corresponding object in repository.

func (ListItem) Title

func (i ListItem) Title() string

Title of the item, that is actually a deck's name.

type Model

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

Model represents state of decks pane.

Decks pane manages all decks in the app.

func New

func New(deckManager flashcard.DeckManager) *Model

func (*Model) Focus

func (m *Model) Focus()

Focus changes style of borders from '--' to '=='.

func (*Model) GetHeight

func (m *Model) GetHeight() int

func (*Model) GetWidth

func (m *Model) GetWidth() int

func (*Model) Init

func (m *Model) Init() tea.Cmd

func (*Model) IsTyping

func (m *Model) IsTyping() bool

func (*Model) SelectedDeck

func (m *Model) SelectedDeck() (int, *ListItem)

func (*Model) SetHeight

func (m *Model) SetHeight(height int)

func (*Model) SetWidth

func (m *Model) SetWidth(width int)

func (*Model) Unfocus

func (m *Model) Unfocus()

Unfocus changes style of borders from '==' to '--'.

func (*Model) Update

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

func (*Model) View

func (m *Model) View() string

type NoDeckSelectedMsg

type NoDeckSelectedMsg struct{}

type UpdateDeckMsg

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