navigation

Documentation

Index

• type Model
• type Search
  • func (s *Search) Begin()
  • func (s *Search) Delete()
  • func (s *Search) Done()
  • func (s *Search) Execute(m Model)
  • func (s *Search) Write(key 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"
	Query string
}

Search represents the current search

func (*Search) Begin

func (s *Search) Begin()

Begin a new search (deletes old buffer)

func (*Search) Delete

func (s *Search) Delete()

Delete the last keystroke from the buffer

func (*Search) Done

func (s *Search) Done()

Mark Search as Done - Do not delete 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) Write

func (s *Search) Write(key string)

Write a keystroke to the buffer

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.