navigation

Documentation

Index

• type Model
• type Search
  • func NewSearch() Search
  • func (s *Search) Begin()
  • func (s *Search) Done()
  • func (s *Search) Execute(m Model)
  • func (s *Search) Query() string
  • func (s *Search) SetQuery(query string)
• type State
  • func Navigate(state State, keyPress string) State

Types

type Model

type Model interface {
	CurrentPage() int
	SetPage(page int)
	Pages() []string
}

Model is an interface for models.model, so that cycle imports are avoided

type Search

type Search struct {
	// Active - Show search bar instead of author and date?
	// Store keystrokes in Query?
	Active bool
	// Query stores the current "search term"
	SearchTextInput textinput.Model
}

Search represents the current search

func NewSearch

func NewSearch() Search

NewSearch creates and returns a new search model with the default settings.

func (*Search) Begin

func (s *Search) Begin()

Begin a new search (deletes old buffer)

func (*Search) Done

func (s *Search) Done()

Done marks the search as done, but does not delete the search buffer. This is useful if, for example, you want to jump to the next result and you therefore still need the buffer.

func (*Search) Execute

func (s *Search) Execute(m Model)

Execute search

func (*Search) Query

func (s *Search) Query() string

Query returns the text input's value.

func (*Search) SetQuery

func (s *Search) SetQuery(query string)

SetQuery sets the text input's value

type State

type State struct {
	Buffer      string
	Page        int
	TotalSlides int
}

State tracks the current buffer, page, and total number of slides

func Navigate

func Navigate(state State, keyPress string) State

Navigate receives the current State and keyPress, and returns the new State.