platformd

type Brand interface {
	// BrandName is shown beside the mark, and is the mark's alt text.
	BrandName() string
	// BrandMark is a URL or inline SVG data URI. Empty is normal and expected:
	// the shell falls back to its own glyph, exactly as UserAvatar does.
	BrandMark() string
}

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

type Identity interface {
	// UserName is who is logged in.
	UserName() string
	// UserAvatar is the URL of their picture. Empty is normal and expected.
	UserAvatar() string
	// UserRoles are display names, not authorization codes. May be empty.
	UserRoles() []string
}

type Platform struct {
	Element

	// AppName titles the drawer on a phone when there is no Brand to lead it —
	// the panel opens wholesale there and there is room for a line of text. The
	// collapsed rail never shows it: text with no icon beside it would have to
	// appear from nowhere when the rail expands.
	//
	// It is a fallback for a missing Brand, not a second header: a Brand
	// supersedes it in the drawer, since showing both would say the app's own
	// name twice in the same panel. A platform with neither renders no head at
	// all above the drawer's nav.
	AppName string

	// Brand is what the platform calls itself: the mark and the name at the
	// header's leading slot, mirrored at the head of the phone drawer where
	// there is no header to hold it. Tapping it — either surface — is the "go
	// home" control, landing on DefaultID (or the first viewable module).
	// Optional — a platform without a logo renders no brand slot, AppName
	// takes the drawer's head instead, and the header's message block stays
	// centred between nothing and the menu.
	Brand Brand

	// User is the logged-in identity. Required: the header's outer thirds and
	// the drawer's first entry are built from it.
	User Identity

	// UserActions slot — shown at the header RIGHT, next to the work-area name
	// (e.g. the light/dark theme toggle). Optional.
	// A factory, not a Component: the shell renders one menu per surface and a
	// single element cannot have two parents. Passing one instance put the same
	// element in both menus, which rendered twice with one id and left the copy
	// in the drawer inert.
	UserActions func() Component

	// Modules registered in order — appearance order in the nav rail.
	Modules []UIModule

	// CanView filters which modules the shell presents. nil = show all.
	CanView func(resource string) bool

	// DefaultID is the ModelName() of the module to show initially.
	// If empty, the first module is used.
	DefaultID string
	// contains filtered or unexported fields
}

type UIModule interface {
	layout.Module    // identity: ModelName() → used as ID
	Label() string   // text in the nav rail
	Icon() svg.Icon  // chassis renders via the sprite
	View() Component // module content (often a *rightpanel.RightPanel)
}