cards

Documentation

Index

• func AddCard(front, back string) tea.Cmd
• func SelectCard(selectedCard *ListItem) tea.Cmd
• func UpdateCard(frontVal, backVal string) tea.Cmd
• type AddCardMsg
• type CardSelectedMsg
• type ListItem
  • func (i ListItem) Back() string
  • func (i ListItem) Description() string
  • func (i ListItem) FilterValue() string
  • func (i ListItem) Front() string
  • func (i ListItem) Title() string
• type Model
  • func New() *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) SelectedCard() (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 NoCardSelectedMsg
• type UpdateCardMsg

Functions

func AddCard

func AddCard(front, back string) tea.Cmd

func SelectCard

func SelectCard(selectedCard *ListItem) tea.Cmd

func UpdateCard

func UpdateCard(frontVal, backVal string) tea.Cmd

Types

type AddCardMsg

type AddCardMsg struct {
	Front, Back string
}

type CardSelectedMsg

type CardSelectedMsg struct {
	CardItem ListItem
}

type ListItem

type ListItem struct {
	DBItem flashcard.Card
}

ListItem to represent card in cards list.

It contains front side of card as Title and back side of card as Description.

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

func (ListItem) Back

func (i ListItem) Back() string

Back side of card.

func (ListItem) Description

func (i ListItem) Description() string

Description of the item, that is actually a card's masked back side.

The Description is masked in order to don't spoil the fun of learning.

func (ListItem) FilterValue

func (i ListItem) FilterValue() string

FilterValue by its front and back side.

func (ListItem) Front

func (i ListItem) Front() string

Front side of card.

func (ListItem) Title

func (i ListItem) Title() string

Title of the item, that is actually a card's front side.

type Model

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

Model represents state of cards pane.

Cards pane manages all cards stored in the selected deck.

func New

func New() *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) SelectedCard

func (m *Model) SelectedCard() (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()

Focus 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 NoCardSelectedMsg

type NoCardSelectedMsg struct{}

type UpdateCardMsg

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