ui

type Bar ¶

type Bar struct {
	X, Y, W, H int
	Day        string
	Clicks     int64
	Visitors   int64
	Bots       int64
}

type Chart ¶

type Chart struct {
	W, H  int
	PlotH int
	MaxY  int64
	Bars  []Bar
	Ticks []Tick
	First string // label of the first day, for the x axis
	Last  string
}

Chart is a bar chart laid out in Go rather than in the browser.

The dashboard's charts are server-rendered SVG. A charting library would be the only piece of custom JavaScript in the product, for four rectangles and an axis — and the CSP disallows inline styles, which most of them generate. Computing integer geometry here keeps the template a dumb loop.

func BarChart(points []DayCount, w, h int) Chart

type DayCount ¶

type DayCount struct {
	Day      string // 2006-01-02
	Clicks   int64
	Visitors int64
	Bots     int64
}

DayCount is one day of a click series as the chart helpers consume it.

A local type rather than analytics.DayPoint, because this package depends on nothing outside the standard library. Handlers convert; the conversion is three assignments and it keeps a template change from ever pulling a service package into the UI.

type DimensionSlice ¶ added in v0.2.0

type DimensionSlice struct {
	Name  string
	Count int64
}

DimensionSlice is the shape DonutChart consumes.

A local type for the same reason DayCount is one: this package depends on nothing outside the standard library, and a handler converting two fields is cheaper than the UI importing the analytics package.

type Donut ¶ added in v0.2.0

type Donut struct {
	// Size is the square viewBox side. Geometry is absolute inside it.
	Size     int
	Segments []DonutSegment
	Total    int64
	// Empty is true when there is nothing to draw, so the template can say so
	// rather than render a ring of nothing.
	Empty bool
}

Donut is a ring chart laid out in Go (M37).

The other half of "richer charts for the other dimensions". A ranked list answers "how many from Chrome"; it does not answer "is this link's traffic one browser or five", which is the question a share chart exists for and the one a column of numbers is worst at.

A ring rather than a pie because the hole is where the total goes, and a total in the middle is what stops somebody reading a 60% slice as a big number when it is 60% of nine clicks.

func DonutChart(items []DimensionSlice, total int64, size int) Donut

type DonutSegment ¶ added in v0.2.0

type DonutSegment struct {
	Path  string
	Class string
	Label string
	Value int64
	Share int
}

DonutSegment is one slice, already turned into a path.

type MapBand ¶ added in v0.2.0

type MapBand struct {
	Class string
	// Upper is the largest figure that falls in this band.
	Upper int64
}

MapBand is one step of the legend.

type MapShape ¶ added in v0.2.0

type MapShape struct {
	Path string
	// Class is the fill utility, already resolved. A template cannot build
	// `fill-choro-{{.Step}}` and have Tailwind find it, so the whole string
	// comes from Go — which is why this file is a @source in input.css, exactly
	// as funcs.go is for the status badges.
	Class string
	// Title is the shape's accessible name and its hover text: the country, and
	// its exact figure. It is what keeps the map honest about a five-band scale.
	Title string
}

MapShape is one country as the template needs it.

type Renderer ¶

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer holds the parsed template set and the fingerprinted asset table.

Templates are parsed once at boot. A syntax error therefore fails startup rather than the first request that happens to reach that page, which is the difference between a deploy that refuses to come up and one that looks healthy until someone clicks the wrong tab.

func New() (*Renderer, error)

func (r *Renderer) AssetURL(name string) string

func (r *Renderer) MailTemplates() []string

func (r *Renderer) MissingAssets() []string

func (r *Renderer) Pages() []string

func (r *Renderer) Render(w http.ResponseWriter, status int, page string, data any) error

func (r *Renderer) RenderMail(name string, data map[string]string) (subject, body string, err error)

func (r *Renderer) RenderPartial(w http.ResponseWriter, status int, page, block string, data any) error

func (r *Renderer) StaticHandler(prefix string) http.Handler

type Tick ¶

type Tick struct {
	Y     int
	Label string
}

type WorldMap ¶ added in v0.2.0

type WorldMap struct {
	ViewBox  string
	FillRule string
	Shapes   []MapShape
	Legend   []MapBand

	// Metric is "clicks" or "visitors": which figure the shading is of.
	Metric string
	// MetricLabel names it in the heading.
	MetricLabel string
	// Caveat is the unique-visitor caveat, repeated **verbatim** whenever the
	// shading is of unique visitors and empty otherwise.
	//
	// Verbatim is the requirement, not a style note. Unique visitors are a
	// privacy-preserving estimate at daily resolution; shading a map by one
	// without carrying the sentence that says so would launder an estimate into
	// a fact, and a map is a great deal more persuasive than a table.
	Caveat string

	// Max is the largest per-country figure, which is what the bands are a
	// fraction of. Zero when nothing was resolved.
	Max int64
	// Countries is how many countries have a nonzero figure.
	Countries int
	// Unmapped lists codes with traffic that this map has no shape for.
	Unmapped []string

	// Unavailable is set when no GeoIP database is configured, and carries the
	// same sentence the ranked list has always used. The map is not rendered at
	// all in that state: a world drawn entirely in the no-data colour is a
	// picture of nothing that looks like a picture of something.
	Unavailable string
}

WorldMap is a country choropleth laid out in Go, ready for a dumb template loop.

Same idiom as BarChart, and for the same three reasons: a charting library would be the only custom JavaScript in the product, the CSP disallows the inline styles most of them generate, and geometry computed here means the template holds no arithmetic. The shapes themselves are generated Go source — see internal/ui/geo — so a dashboard request never parses a map file.

func Choropleth(values map[string]int64, metric, caveat string, available bool) WorldMap