model

Documentation

Index

• type Model
  • func (m *Model) CurrentPage() int
  • func (m Model) Init() tea.Cmd
  • func (m *Model) Load() error
  • func (m *Model) Pages() []string
  • func (m *Model) SetPage(page int)
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string

Types

type Model

type Model struct {
	Slides   []string
	Page     int
	Author   string
	Date     string
	Theme    glamour.TermRendererOption
	Paging   string
	FileName string

	// VirtualText is used for additional information that is not part of the
	// original slides, it will be displayed on a slide and reset on page change
	VirtualText string
	Search      navigation.Search
	// contains filtered or unexported fields
}

Model represents the model of this presentation, which contains all the state related to the current slides.

func (*Model) CurrentPage

func (m *Model) CurrentPage() int

CurrentPage returns the current page the presentation is on.

func (Model) Init

func (m Model) Init() tea.Cmd

Init initializes the model and begins watching the slides file for changes if it exists.

func (*Model) Load

func (m *Model) Load() error

Load loads all of the content and metadata for the presentation.

func (*Model) Pages

func (m *Model) Pages() []string

Pages returns all the slides in the presentation.

func (*Model) SetPage

func (m *Model) SetPage(page int)

SetPage sets which page the presentation should render.

func (Model) Update

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

Update updates the presentation model.

func (Model) View

func (m Model) View() string

View renders the current slide in the presentation and the status bar which contains the author, date, and pagination information.