ui

type Action struct {
	Label  string
	Href   string
	Post   string // form action; the CSRF token is added
	Icon   string // optional icon name shown before the label in a row menu
	Danger bool
	NewTab bool              // open Href in a new tab (a link menu item only)
	Fields map[string]string // hidden fields sent with a Post action
	// Confirm makes the action ask first. Href is then the confirmation page
	// (works without JavaScript) and Post the action the page submits; with JS
	// the link opens a native <dialog> showing Confirm instead of navigating.
	Confirm      string
	ConfirmLabel string // the dialog's confirm button (default: Label)
}

type AiaAgentGroup struct {
	Purpose, Description string
	Summary              string     // "27,997 fetches, 50% of all AI fetches."
	Policy               *AiaPolicy // the group's Allow / Block control; nil shows none
	Rows                 []AiaAgentRow
	// PolicyOnly are robots.txt names that never fetch (Google-Extended).
	PolicyOnly []AiaPolicyOnly
}

type AiaAgentRow struct {
	Name, Href, Operator string
	Fetches              string
	Share                int
	Verification         Badge
	Blocked, Ignores     bool // blocked by the purpose's policy; ignores robots.txt
	// Purpose is the purpose id the row sits under (policy.js shows "Blocked by
	// policy" from it); Fetched is true when the agent fetched in the range.
	Purpose  string
	Fetched  bool
	LastSeen string
}

type AiaAgents struct {
	Caption string
	Groups  []AiaAgentGroup
	// Other are the non-AI purposes (search, social, SEO, archive).
	Other []AiaOtherPurpose
}

type AiaAttention struct {
	Sev               int
	Count, Text, Rate string
	Note              string // muted line under the rate
	Href, Action      string // link and its label ("Review spoofed")
}

type AiaCell struct {
	Text, Href, Mono string
	Muted            bool
	Button           bool // the link is a small secondary button
	Badge            *Badge
}

type AiaChart struct {
	// ID is the card id ("w-ct-first"): the anchor of the attention links.
	ID, Title, Description string
	Src, Chart             string // JSON endpoint and the key under "charts"
	// Panels are further keys of the same JSON ("fetches|referrals"), Srcs one
	// endpoint per panel when they differ ("a.json|b.json"), PanelLabels the
	// title above each panel.
	Panels, Srcs, PanelLabels string
	// Sum names, per panel ("AI fetches|AI-referred visits"), the one series
	// that panel's datasets are added up into.
	Sum string
	// Ratio ("referrals,pageviews") draws the first chart over the second,
	// labelled RatioLabel.
	Ratio, RatioLabel string
	// Override is JSON restyling a series by name: {"Spoofed":{"cls":"hm-viz--danger"}}.
	Override string
	Hero     bool // taller plot
	Cols     bool // columns instead of an area
	Compare  bool // the page is comparing; the legend shows "Previous period"
	Table    DataTable
}

type AiaOtherPurpose struct {
	Purpose, Name, Description string
	Policy                     *AiaPolicy
}

type AiaPolicy struct {
	Purpose, Legend string
	Deny, Owner     bool
}

type AiaPolicyForm struct {
	CSRF, Return string
	Owner        bool
}

type AiaPolicyOnly struct{ Name, Href, Operator string }

type AiaRows struct {
	Caption string
	Columns []string
	// Right and HiddenHead, when set, are one flag per column: right-aligned
	// figures, and a header kept for screen readers but not drawn.
	Right, HiddenHead []bool
	Rows              [][]AiaCell
	Page              Pagination
	Empty             string
}

type Badge struct {
	Label string
	Kind  string // neutral | success | warning | danger | info
	// Icon is an optional icon name drawn before the label (the delta arrows).
	Icon string
	// Plain drops the dot of a neutral label, Wrap lets long text wrap, Mono is a read-only
	// identifier or tag (monospace, wraps). A coloured Kind keeps its dot either way.
	Plain, Wrap, Mono bool
}

type Bar struct {
	Label, Kind string
	Pct         float64
}

type BarItem struct {
	Label, Href, Value string
	Note, Share        string
	N                  float64
}

type BarList struct {
	Label string // accessible name of the list, required
	// NameHeading and ValueHeading are the optional column captions above the
	// list ("Source", "Visits").
	NameHeading, ValueHeading string
	Items                     []BarItem
	Empty                     string // shown when Items is empty
	Quiet                     bool   // paler bars (--chart-bar-quiet), for dense lists
	Mono                      bool   // names in the monospace face (paths)
}

type BarRow struct {
	BarItem
	Width string
}

type BulkAction struct {
	Label, Action, Value string
	Danger               bool
	// Confirm makes the button ask first when JavaScript runs ("{n}" is the
	// number of checked rows). Without JavaScript the button posts and the
	// handler answers with a confirmation page.
	Confirm string
}

type Button struct {
	Label     string
	Variant   string // primary | secondary | ghost | danger
	Size      string // md | sm
	Type      string // button | submit
	Href      string // renders an <a>
	Icon      string
	IconOnly  bool
	AriaLabel string // required with IconOnly
	Attrs     map[string]string
}

type ButtonMenu struct {
	ID, Label, Icon string
	Items           []Action
	// Footer items come last behind a separator.
	Footer []Action
}

type Callout struct {
	Kind, Title, Body, ID, DismissKey string
	Compact                           bool
	Attrs                             map[string]string // extra data-*/aria-* attributes on the root
}

type CategoryBar struct {
	Label    string // accessible name, required
	Segments []CategorySegment
	Marker   *CategoryMarker
	// Columns lays the legend out as rows with the Value and the Share in
	// right-aligned columns, as the analytics pages do.
	Columns bool
}

type CategoryMarker struct {
	At    float64
	Label string // "Target: 75%", shown in the legend
}

type CategorySeg struct {
	CategorySegment
	Class, X, Width string
	// First and Last mark the two outer segments: only they get rounded
	// corners, so the bar reads as one rounded strip (an SVG rect cannot
	// round a single side).
	First, Last bool
}

type CategorySegment struct {
	Label, Value, Kind string
	// Share is the percentage column of a Columns legend; ignored otherwise.
	Share string
	N     float64
}

type Cell struct {
	Text     string
	Link     string
	Badge    *Badge
	Depth    int    // indent of a tree row's name, in levels
	Nowrap   bool   // keep the text on one line (dates)
	Clip     bool   // cut long text with an ellipsis; the full text is the title (addresses)
	Sub      string // muted monospace line under the text (a URL path)
	Initials string // decorative avatar before the text (a person's initials)
	Suffix   string // muted text after the name, e.g. "(you)"
	Tag      *Badge // small badge after the text, e.g. "not encrypted"
	Bar      *Bar   // inline proportion bar after the text
	Spark    *Spark // trend line after the text (a focusable role=img with a summary)
}

type Chip struct{ Label, RemoveHref string }

type Col struct {
	Key, Label string
	Sortable   bool
	Align      string // "" | right
	// Role shapes the column: title (takes the slack and wraps), num (right,
	// tabular digits), check, actions. With no title column, the first is it.
	Role string
	// WideOnly drops the column's cells from the compact phone cards (below
	// 640px); the header stays in the sort strip only if it is sortable.
	WideOnly bool
}

type ConfirmHidden struct{ Name, Value string }

type Confirmcard struct {
	Post, Back, Label, Message, CancelLabel, CSRF string
	Danger                                        bool
	Hidden                                        []ConfirmHidden
}

type Crumb struct{ Label, Href string }

type DangerConfirm struct {
	// ID keeps element ids unique when several cards share a page.
	ID    string
	Title string
	// Phrase is what the user must type, compared exactly.
	Phrase string
	// Prompt is the visible label of the phrase input.
	Prompt string
	// Action is the form post target; Back is the Cancel link.
	Action string
	Back   string
	// Label is the danger submit text; CancelLabel defaults to "Cancel".
	Label       string
	CancelLabel string
	CSRF        string
	// Error is set by the server helper after a failed check.
	Error string
	Body  []DangerText
	// Hidden carries extra fields the caller needs re-posted.
	Hidden []ConfirmHidden
}

type DangerPart struct {
	Text         string
	Code, Strong bool
}

type DangerText struct{ Parts []DangerPart }

type DataRow struct {
	Label string
	Cells []string
}

type DataTable struct {
	Caption string
	Columns []string
	Rows    []DataRow
	// Total, when set, is a closing row (column sums).
	Total *DataRow
	Empty string
	// Flat drops the scroll box: the table is as tall as its rows (chart data).
	Flat bool
}

type DateCompare struct {
	Field    string // query param the switch posts, "compare"
	On       bool
	Disabled bool   // no earlier data to compare with
	Label2   string // the button's second line, "vs 25 Aug – 23 Sep" (shown only when On)
	Help     string // "Compared with 25 Aug – 23 Sep."
}

type DatePreset struct {
	Label, Href string
	Active      bool
}

type DateRange struct {
	// ID prefixes the popover and input ids (default "range"), so two pickers can share a page.
	ID       string
	Action   string
	From, To string
	Hidden   map[string]string
	// Label is the picker button text: the matching preset's name and the span ("Last 30 days · 20 Sep – 19 Oct"), else "From - To".
	Label string
	// Quick is the preset list inside the picker popover; Min and Max bound the
	// date inputs (Max is today, UTC).
	Quick    []DatePreset
	Min, Max string
	// Compare adds a "Compare to previous period" switch to the popover. Nil (the default) renders the picker unchanged.
	Compare *DateCompare
}

type Dropzone struct {
	ID      string
	Name    string
	Accept  string
	Help    string
	MaxMB   int
	Compact bool
}

type Empty struct {
	Icon, Title, Body string
	Actions           []Button
	// Compact drops the padding and the border for an empty list inside a card.
	Compact bool
	// Code is a muted status above the title ("404"); Plain centres it with no frame, for a panel.
	Code  string
	Plain bool
	// Regular sets the title in normal weight, for a plain sentence rather than a heading.
	Regular bool
	// H1 makes the title the page heading, for a full-page error.
	H1 bool
}

type FieldError struct{ ID, Label, Message string }

type Filter struct {
	Name, Label string
	Options     []Option
	// Input renders an <input type=Input> (for example "date") holding Value
	// instead of a <select>.
	Input, Value string
}

type Option struct {
	Value, Label string
	Selected     bool
}

type PageLink struct {
	N       int
	Current bool
}

type Pagination struct {
	Page, PerPage, Total int
	BaseURL              string
	Query                url.Values
	Window               int // pages shown each side of the current page (default 2)
	// Param is the query parameter that carries the page number (default "page"),
	// for a page with more than one list.
	Param string
}

type Progress struct {
	Label, Value, Kind string
	Pct                float64
}

type RadioCard struct {
	Legend, Name string
	// IDPrefix keeps ids unique when a page holds several groups with the same Name.
	IDPrefix string
	Cols     int
	Items    []RadioCardItem
}

type RadioCardItem struct {
	Value, Title, Description string
	Checked                   bool
	Tag                       *Badge
	Initials                  string // decorative avatar before the title (a person)
}

type Row struct {
	ID      string
	Label   string // accessible name of the row (checkbox label)
	Cells   []Cell
	Actions []Action
}

type Savestate struct {
	State string
	Text  string
}

type Secret struct{ Heading, Note, Value, DismissHref string }

type Segmented struct {
	Mode   string
	Label  string
	Action string
	Name   string // required in post and radio modes; unused in buttons mode
	CSRF   string
	Attrs  map[string]string // on the container (every mode)
	Items  []SegmentedItem
}

type SegmentedItem struct {
	Label, Value string
	Pressed      bool
	Attrs        map[string]string
}

type Spark struct {
	Line, Area string
	ID         string
	Summary    string
	Kind       string
	// PrevLine and Divider are set only by SparkSplitOf: the earlier period's
	// polyline (drawn grey, Line and Area then cover the later period) and the
	// x of the divider between the two, in the same box.
	PrevLine, Divider string
	// Live, when set, leaves Line and Area empty: js/aia/page.js reads the chart of a data
	// endpoint and sets the two paths, the label and the tooltip on this same markup.
	Live *SparkLive
}

type SparkLive struct {
	Src, Chart, Ratio, Dataset string
	MinMax                     bool
}

type Stat struct {
	Label, Value, Detail string
	Pct                  int
	// Ring picks the ring card inside a ticker grid; Pct is then the ratio.
	Ring   bool
	Change *StatChange
	// Note is the optional muted line under a ticker card.
	Note string
	// Link is the optional footer link of a ring card ("View more"); a ticker
	// card shows it as a plain link under its Note.
	Link, LinkLabel string
	// Badge replaces Value on a ticker card whose value is a status, not a number
	// ("Up to date"): a metric is 30px semibold, a status is a badge.
	Badge *Badge
	// Spark is the optional trend line under a ticker card's value.
	Spark *Spark
}

type StatChange struct {
	Dir, Text, Tone, Caption string
}

type Step struct {
	Label         string
	Current, Done bool
}

type Tab struct {
	Label, Href string
	Count       int
	Active      bool
}

type TabMore struct {
	ID, Label, Filter string
	Items             []Tab
}

type Table struct {
	ID, Caption, BaseURL string
	CSRF                 string
	Columns              []Col
	Rows                 []Row
	SortKey, SortDir     string // asc | desc
	Query                string // search text
	SearchLabel          string // "" hides the search box
	Filters              []Filter
	// PrimaryFilters (selects) sit beside the search box. PopoverFilters live
	// in a "Filters" popover; Chips list the active popover filters, each with
	// a link that drops only that one, and ClearHref drops them all. Setting
	// either PopoverFilters or Chips selects the filter bar layout over Filters.
	PrimaryFilters []Filter
	PopoverFilters []Filter
	Chips          []Chip
	ClearHref      string
	Hidden         map[string]string // fixed query values the filter form carries, e.g. the open form
	Bulk           []BulkAction
	BulkURL        string
	Page           Pagination
	Empty          Empty
	Error          string // non-empty renders the error state with Retry
	// CreatedID marks the row with this ID as just created: it gets the
	// hm-row--new class and a visually hidden "(new)" so colour is not alone.
	CreatedID string
}

type Tracker struct {
	Label      string // accessible name of the row, required
	Blocks     []TrackerBlock
	Start, End string
	Legend     []TrackerKey
	// States draws the analytics cues: hatched danger blocks, shorter warning
	// blocks and hollow neutral blocks, so the state is not colour alone.
	States bool
}

type TrackerBlock struct {
	Kind, Tip string
}

type TrackerKey struct {
	Kind, Label string
}