Naar de inhoud springen
Geverifieerd

Xuda Slim

Het lichte browsertoegangspunt tot de Xuda-runtime, zonder projectlader.

Xuda Slim is het lichte schrijf- en insluitoppervlak voor de Xuda-runtime. Het is nuttig als je de reactieve datasource, directives, events en structurele tags van Xuda wilt, zonder te beginnen met de volledige projectindeling van de Xuda CLI.

Slim is nog steeds Xuda, geen andere runtime. Expressies lezen velden nog steeds met @field_name, de runtime werkt nog steeds met Xuda-programmadocumenten en structurele tags zoals xu-single-view en xu-panel doen nog steeds mee. <template> wordt ondersteund, maar is niet verplicht.

Waarvoor Slim dient

  • met de hand geschreven HTML-pagina's met Xuda-reactiviteit
  • runtimedemo's en documentatie
  • insluitbare widgets of microsites
  • gegenereerde project_data-runtimebomen
  • stapsgewijs Xuda gaan gebruiken zonder eerst een volledige broncompiler in te voeren

De drie schrijfmodi

Deze modi kunnen worden gemengd: als Slim project_data ontvangt en de pagina ook <template>-tags heeft, worden de templates geparsed en erbij gevoegd in project_data.programs.

De runtime laden

De ondersteunde manier om de bundel te krijgen is het openbare npm-pakket @xuda.io/xuda-runtime-slim-es. Heb je een gedeployde Xuda-app, dan serveert het platform de runtimebundel ook vanaf je eigen appdomein op /cdn, met een niet-geminimaliseerde build op /cdn/debug.

html
<script src="https://xuda.ai/dist/runtime/js/xuda-runtime-slim.js"></script>
Laad niet van een devhost in productie

De scripttag hierboven wijst naar een ontwikkelhost, handig om Slim lokaal uit te proberen. Een gedeployde pagina moet @xuda.io/xuda-runtime-slim-es laden, of de bundel serveren vanaf je eigen appdomein op /cdn.

De constructor

js
new xuda(element?, options?, callback?)
new xuda.xuda(element?, options?, callback?)

Argumenten worden op type herkend, niet op positie: een element, een opties-object en een callback mogen in elke volgorde worden doorgegeven.

  • element: het DOM-element om in te mounten. Optioneel in Slim: laat je het weg, dan valt de runtime terug op document.body en logt een waarschuwing in plaats van te falen.
  • options: sessie- en runtimeopties, hieronder behandeld.
  • callback: aangeroepen als callback('xuda_ready', SESSION_ID, SESSION_OBJ) zodra de app klaar is.

Voor het voltooien van de mount is de betrouwbaarste hook het event on_mounted op document.body:

js
document.body.addEventListener('on_mounted', () => {
  console.log('Slim page mounted');
}, { once: true });

Veelgebruikte opties

Elke optie hieronder wordt opgelost via dezelfde keten van zes stappen: eerst een URL-queryparameter, dan een attribuut op het root-element, dan options.params[key], dan options[key], dan een cookie, dan localStorage. Daarom kan een Slim-pagina vanuit een querystring opnieuw worden geconfigureerd zonder codewijziging.

Hoe je weet dat Slim werkt

  • de bundel is geladen
  • je prog_id toont iets zichtbaars
  • het event on_mounted wordt afgevuurd
  • veldgestuurde UI-updates gaan zich reactief gedragen

Gebeurt dat alle vier, dan zit de pagina goed. Wordt er niets getoond, controleer dan in deze volgorde: is de bundel echt geladen, komt prog_id overeen met een echte template-id of programmasleutel, bestaat het programma in project_data.programs, en is het mountdoel een echt element (of bewust overgelaten aan de terugval op body).