Widget

MMO.elements · 1 symbol · generated 30 Sep 2026

mixin

Widget

Widget WARNING: It is a class mixin. Meaning you extend it with a parameter

class MMO.elements.Widget extends MMO.elements.CustomShadowElement(ClassElement)

Namespace: MMO.elements
Extends: CustomShadowElement(ClassElement)

A shadow custom element that loads a collection from the framework's repository API and exposes it to the view as two maps: - `data`: the fetched entities, indexed by uid - `fields`: one descriptor per schema property (title, order, hidden, readonly, width, ...), sorted with the schema's own property order. `MMO.elements.Widget#updateFields` NOTE: `MMO.elements.CustomAPIElement` covers the same ground with a plain MMO.core.APIRequester and is the one to reach for in new code. This mixin is kept for the field-descriptor machinery, which CustomAPIElement does not provide.

class T extends MMO.elements.Widget(HTMLElement) {..}

Index

	url accessor	Point the widget at a collection; it loads as soon as the element becomes visible.
	limit accessor	Number of entities to request per page.
	meta readonly accessor	Meta block of the last response (`{data: {total, class}, page: {offset, index, total}}`), or null when nothing has been loaded yet.
	fields accessor	One descriptor per schema property: title, order, hidden, readonly, width, icon...
	data accessor	The entities of the last load, indexed by uid.
	readonly accessor
	constructor()
	setSchema(schema)	Attach the schema describing the loaded entities, resolving an `instanceOf` schema to the concrete one, then rebuild the field descriptors.
	load(url)	Fetch a collection and publish it as `data`, rebuilding `fields` from the response schema.
	reload()	Re-fetch the url that was last loaded.
	updateFields()	Rebuild `fields` from the schema's properties, merging into the descriptors already there so a manual override survives a reload.
	showAllFields()	Un-hide every field.

schema	MMO.schemas.Schema \| `Object` \| `Promise`
returns	`Promise<MMO.schemas.Schema>`

url	`string`	the collection's url; pagination is appended unless already present
returns	`Promise<void>`

Widget

Widget

Index

Properties6

url

limit

meta

fields

data

readonly

Methods6

constructor()

setSchema(schema)

load(url)

reload()

updateFields()

showAllFields()