adminregistry

type Display struct {
	Text string
	Href string
}

type DisplayFunc func(context.Context, any) Display

type FieldContext struct {
	// Name is the model field's Go name — also the base name a simple
	// widget reads directly from the submitted form, and the stable prefix
	// a multi-input widget derives its own input names from.
	Name string
	// Label is the field's display label (from Options.Labels, or a
	// humanized default).
	Label string
	// HelpText is optional descriptive text for the field (from
	// Options.HelpText); empty if unset.
	HelpText string
	// Value is the field's current value, formatted for display. Empty for
	// a new (zero) instance.
	Value string
	// MaxLength is the field's declared maximum length in characters (a
	// tango:"varchar=n" string), or 0 when the field is unbounded. The
	// built-in input renders it as the maxlength attribute; the server stays
	// the authority, since browsers count in UTF-16 units.
	MaxLength int
	// Checked is the field's current boolean value, for checkbox-shaped
	// widgets.
	Checked bool
	// ReadOnly reports whether the field should render non-editably and
	// ignore submitted form data entirely (Options.ReadOnly). A Widget set
	// via Options.Widgets is never consulted for a ReadOnly field — the
	// admin package renders a single generic read-only presentation
	// instead, uniformly, regardless of which Widget the field would
	// otherwise use.
	ReadOnly bool
	// SelectOptions lists every row of the related model as a value/label
	// pair, populated only for a foreign key field whose related model is
	// registered — nil otherwise.
	SelectOptions []SelectOption
	// RelatedCreateURL links to the related model's admin create page for
	// foreign-key fields whose related model is also admin-registered.
	// Empty means no quick-create affordance should render.
	RelatedCreateURL string
	// PreviewURL is the absolute admin URL a preview widget posts its text
	// to; empty for a widget that is not a PreviewWidget.
	PreviewURL string
	// RelatedCreateLabel is the accessible label for RelatedCreateURL.
	// Empty means widgets may fall back to their own default.
	RelatedCreateLabel string
	// Error is the message the form shows beside this field after a failed
	// save, or empty when the field has no error. The built-in widgets mark
	// their control aria-invalid when it is set; a custom widget may do the
	// same.
	Error string
}

type FieldValues interface {
	Get(key string) string
	Has(key string) bool
}

type ModelRegistration struct {
	Model   model.ModelMeta
	Options Options
}

type Options struct {
	ListDisplay []string
	// SingularName and PluralName name one row and several rows in messages
	// and confirmations, such as "Delete this book" and "3 books deleted".
	// Unset, each falls back to the humanized Go type name.
	SingularName string
	PluralName   string
	// Display computes changelist cells, keyed by a name in ListDisplay: a
	// registered field (overriding its value) or a synthetic column, which
	// needs a Labels entry for its header. See DisplayFunc.
	Display  map[string]DisplayFunc
	Search   []string
	Ordering []string
	// Label names one of this model's own fields to display whenever it is
	// shown as a related object elsewhere (e.g. on a Post's admin page for
	// a Post.AuthorID foreign key). Unset falls back to showing the raw
	// primary key value — never a hard error.
	Label string
	// Labels overrides a field's humanized default display label, keyed by
	// Go field name.
	Labels map[string]string
	// HelpText adds descriptive text below a field's form control, keyed by
	// Go field name.
	HelpText map[string]string
	// ReadOnly lists fields that render non-editably in create/edit forms.
	// On edit, a read-only field keeps its existing stored value regardless
	// of submitted form data; on create, it stays at its Go zero value.
	// Submitted data for a read-only field is always ignored, never parsed.
	ReadOnly []string
	// FieldOrder lists fields in the order they should render; fields not
	// listed keep their existing default order after the ordered ones.
	FieldOrder []string
	// Widgets overrides how a field renders and parses in create/edit
	// forms, keyed by Go field name. See Widget — best-effort, not a
	// stable contract.
	Widgets map[string]Widget
	// Filters lists boolean and foreign key fields the changelist can be
	// filtered by, in the order they appear above the list.
	Filters []string
	// BulkDelete lets a staff account delete the rows checked on one
	// changelist page, after a confirmation, in one all-or-nothing
	// transaction. Rows that reference a deleted row are deleted with it,
	// exactly as in a single-row delete. Off by default; it needs JavaScript
	// in the browser and never spans more than one page of rows.
	BulkDelete bool
}

type PreviewWidget interface {
	Preview(ctx context.Context, source string) (template.HTML, error)
}

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

type SelectOption struct {
	Value    string
	Text     string
	Selected bool
}

type Widget interface {
	Render(ctx context.Context, f FieldContext) template.HTML
	Parse(ctx context.Context, f FieldContext, form FieldValues, dest reflect.Value) error
}