tui

Documentation

Index

• func CLI(args []string, stdout io.Writer, stderr io.Writer) int
• func RenderMarkdown(text string, width int) (string, error)
• type Model
  • func NewModel(path string, opts ...ModelOption) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type ModelOption
  • func WithClock(clock clock.Clock) ModelOption
  • func WithRepository(factory func(clock.Clock) (Repository, error)) ModelOption
  • func WithWindowSize(width, height int) ModelOption
• type Repository
• type Shared
• type Styles
  • func NewStyles(lg *lipgloss.Renderer) *Styles

Functions

func CLI

func CLI(args []string, stdout io.Writer, stderr io.Writer) int

func RenderMarkdown

func RenderMarkdown(text string, width int) (string, error)

Types

type Model

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

func NewModel

func NewModel(path string, opts ...ModelOption) Model

NewModel creates a new model instance given a decks location.

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 ModelOption

type ModelOption func(*Model)

ModelOption configure the Model options.

func WithClock

func WithClock(clock clock.Clock) ModelOption

WithClock initializes the model with the given clock.

func WithRepository

func WithRepository(factory func(clock.Clock) (Repository, error)) ModelOption

WithRepository configure the terminal with an alternative repository.

func WithWindowSize

func WithWindowSize(width, height int) ModelOption

WithWindowSize initializes the model with the given width and height.

type Repository

type Repository interface {
	List() []flashcard.Deck
	Create(name string, cards []flashcard.Card) (flashcard.Deck, error)
	Save(flashcard.Deck) error
	Delete(flashcard.Deck) error
}

Repository wraps the file system operation to be easier and quicker run the tests.

type Shared

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

type Styles

type Styles struct {
	ListMargin,
	Margin,
	Title,
	SubTitle,
	Text,
	SelectedTitle,
	SelectedDesc,
	DeletedTitle,
	DeletedDesc,
	DeletedStatus,
	DimmedTitle,
	Help lipgloss.Style
}

func NewStyles

func NewStyles(lg *lipgloss.Renderer) *Styles