appstate

Documentation

Index

• Constants
• Variables
• type AppState
  • func New(dSource string, files []*parsren.RenderedMdFile, title string) *AppState
  • func (as *AppState) InitialLabels() loader.LabelList
  • func (as *AppState) SetInitialFileIndex(p string)
• type Facts
• type HtmlAndLabels
• type InitialRender

Constants

const BadId = -1

Variables

var (
	//go:embed appstate.js
	Js string
)

Types

type AppState

type AppState struct {
	InitialRender
	RenderedFiles []HtmlAndLabels
}

func New

func New(
	dSource string, files []*parsren.RenderedMdFile, title string) *AppState

func (*AppState) InitialLabels

func (as *AppState) InitialLabels() loader.LabelList

func (*AppState) SetInitialFileIndex

func (as *AppState) SetInitialFileIndex(p string)

type Facts

type Facts struct {
	InitialFileIndex      int
	InitialCodeBlockIndex int
	NumFolders            int
	MaxCodeBlocksInAFile  int
	MaxNavWordLength      int
	IsNavVisible          bool
	IsTitleVisible        bool
}

type HtmlAndLabels

type HtmlAndLabels struct {
	Html            template.HTML
	CodeBlockLabels loader.LabelList
}

HtmlAndLabels has the rendered HTML from a markdown file, plus a list of code labels, one label (the main label) for each code block in the file.

type InitialRender

type InitialRender struct {
	Title        string
	DataSource   string
	OrderedPaths []loader.FilePath
	Facts        Facts
}