ui

type Cell struct {
	Kind    CellKind
	Text    string
	Title   string // the whole value, when Text is cut or formatted
	Bool    bool
	Mono    bool
	Numeric bool
	Href    string // a link to a related row
	Note    string // the related row's name, beside its key
}

type CellKind int

type Chrome struct {
	SiteTitle string
	Base      string // BasePath, without the trailing slash
	PageTitle string
	User      string // username, "" on the login page
	LogoutURL string // "" when the Authenticator serves no logout
	Nav       []NavGroup
	Active    string // slug of the model the page is about
	Crumbs    []Crumb
	Flash     *Flash
}

type Crumb struct {
	Label, URL string // the last crumb has no URL
}

type DeleteObject struct {
	Label, URL string
}

type DeletePage struct {
	Chrome    Chrome
	Heading   string
	Objects   []DeleteObject
	Action    string
	CancelURL string
	Keys      []string // the primary keys a bulk delete posts back
	Bulk      bool
	Dialog    bool // shown over the page by Datastar, not as a page
	Label     string
	Plural    string
}

type Filter struct {
	Label   string
	Note    string
	Options []FilterOption
}

type FilterOption struct {
	Label, URL string
	Active     bool
}

type Flash struct {
	Error bool
	Text  string
}

type FormField struct {
	Name     string
	Label    string
	Help     string
	Note     string // a hint the type adds: UTC, one per line, NULL
	Error    string
	Input    InputKind
	Value    string
	Checked  bool
	Required bool
	Mono     bool
	Options  []Option
	Cell     Cell // what a read-only field shows
	Related  *Cell
}

type FormPage struct {
	Chrome     Chrome
	Heading    string
	Action     string
	FormError  string
	Fields     []FormField
	Adding     bool
	CanSave    bool
	DeleteURL  string
	HistoryURL string
	Inlines    []InlineList
	SaveLabel  string
}

type HistoryPage struct {
	Chrome  Chrome
	Heading string
	Entries []LogEntry
	Empty   string
}

type IndexPage struct {
	Chrome  Chrome
	Groups  []NavGroup
	Recent  []LogEntry
	LogURL  string
	Audited bool
}

type InlineList struct {
	Plural  string
	Columns []string
	Rows    []ListRow
	Total   int64
	AllURL  string
	AddURL  string
}

type InputKind int

type ListColumn struct {
	Label   string
	SortURL string // "" when the column does not sort
	Sorted  string // "asc", "desc" or ""
	Numeric bool
}

type ListPage struct {
	Chrome      Chrome
	Plural      string
	Label       string
	ListURL     string
	AddURL      string
	Search      *Search
	Hidden      []Param // the filters and order the search form keeps
	Columns     []ListColumn
	Rows        []ListRow
	Filters     []Filter
	Total       int64
	Pager       Pager
	CanDelete   bool
	ClearURL    string // "" when nothing is filtered or searched
	ResultLabel string
}

type ListRow struct {
	PK    string
	URL   string
	Label string // the row's name, for the checkbox's label
	Cells []Cell
}

type LogEntry struct {
	Time, User, Action, Model, Object, ObjectURL, Message string
	ActionClass                                           string // add, change, delete
}

type LogPage struct {
	Chrome  Chrome
	Entries []LogEntry
	Pager   Pager
	Empty   string
}

type LoginPage struct {
	Chrome   Chrome
	Action   string
	Next     string
	Username string
	Error    string
}

type MessagePage struct {
	Chrome  Chrome
	Heading string
	Text    string
}

type NavGroup struct {
	Name   string
	Models []NavModel
}

type NavModel struct {
	Slug, Plural, URL, AddURL string
}

type Option struct {
	Value, Label string
	Selected     bool
}

type PageLink struct {
	Label, URL string
	Current    bool
	Gap        bool
}

type Pager struct {
	Page, Pages int
	PrevURL     string
	NextURL     string
	Links       []PageLink
}

type Param struct{ Name, Value string }

type Search struct {
	Value, Placeholder string
}