Preskočiť na obsah
Overené

Jazyk .xu

Blokový formát, v ktorom je napísaný každý zdrojový súbor .xu, a jedenásť stavebných blokov, z ktorých sa projekt skladá.

Súbor .xu je blokový súbor, nie modul JavaScript. Každý blok rieši jednu vec a objektové bloky (<meta>, <params>, <fields>, <actions>, <events>, <datasource>) sa parsujú ako literály v štýle JSON5: kľúče bez úvodzoviek, polia aj vnorené objekty sú v poriadku.

Jedenásť stavebných blokov

Priečinok, v ktorom zdrojový súbor leží, určuje, na aký druh jednotky sa skompiluje. Dobrá aplikácia Xu je zvyčajne prehľadnejšia, keď každá starosť dostane vlastnú jednotku namiesto jedného súboru, ktorý robí všetko.

App.xu je jediný vyhradený súbor: je vždy koreňovou aplikáciou a vždy sa skompiluje na id programu app. Pre súbor component sa id určuje v poradí z meta.id, potom mount.id a potom z vlastného základného názvu súboru. Každý ďalší typ jednotky nemá blok <mount>, takže jeho id sa určuje z meta.id a potom zo základného názvu súboru. Pre zdroje JSON5 je poradie id, potom _id, potom základný názov. Duplicitné id v rámci projektu nie sú povolené.

Bloky podľa typu jednotky

App.xu nikdy nepotrebuje blok <mount>. Bežný komponent ho potrebuje len vtedy, keď ho chcete pripojiť priamo do stránky HTML namiesto cesty cez <panel program="...">:

xml
<mount>
{
  id: "marketing_hero",
  file: "landing.html",
  selector: "#hero"
}
</mount>

Jazyk šablón

Vnútri <template> sa malá sada priateľských aliasov kompiluje na vlastné značkovanie xu-* runtime.

xml
<template>
  <single-view>
    <section class="screen">
      <input bind="search_v" placeholder="Search students">
      <button @click="togglePanel">Toggle panel</button>

      <div if="@show_panel_v">
        <panel program="student_details" />
      </div>
    </section>
  </single-view>
</template>

Komponent od začiatku do konca

xml
<meta lang="json5">
{
  id: "student_list",
  menuTitle: "Student List",
  uiFramework: "@xuda.io/xuda-framework-plugin-tailwind"
}
</meta>

<fields lang="json5">
{
  show_panel_v: { type: "boolean", value: false },
  student_count_v: { type: "number", value: 3 }
}
</fields>

<actions lang="json5">
{
  togglePanel: [
    { action: "update", name: { value: "@show_panel_v: !@show_panel_v" } }
  ]
}
</actions>

<template>
  <single-view>
    <section class="p-6 space-y-4">
      <h1>Students</h1>
      <p :content="'Count: ' + @student_count_v"></p>
      <button class="rounded-full px-4 py-2 bg-sky-600 text-white" @click="togglePanel">
        Toggle details
      </button>
      <div if="@show_panel_v">
        <panel program="student_details" />
      </div>
    </section>
  </single-view>
</template>

<script> sa kompiluje do modulu pripojenia na strane klienta: predvolený export dostane objekt kontextu a môže vrátiť funkciu uvoľnenia, ktorá sa spustí pri odchode. Bloky <style> sa zhromažďujú do jednej poskytovanej šablóny štýlov komponentu.

Formát zdroja dát

Použite čitateľnú obalovú formu vnútri <datasource lang="json5">. type je jedno z none, table, array, json alebo csv.

xml
<datasource lang="json5">
{
  type: "table",
  table: "student_profiles_table",
  filter: {
    mode: "index",
    activeIndex: "campus_idx",
    indexes: {
      campus_idx: { campus: { from: "@campus_in", to: "@campus_in" } }
    }
  },
  output: "students_out",
  direction: "asc",
  realtime: true,
  limit: 25
}
</datasource>
xml
<datasource lang="json5">
{
  type: "table",
  table: "student_tasks_table",
  filter: {
    mode: "query",
    query: { $and: [{ status: "Open" }, { campus: "Boston Campus" }] }
  },
  output: "tasks_out"
}
</datasource>
xml
<datasource lang="json5">
{
  type: "json",
  source: { url: "https://example.com/students.json" },
  output: "students_out"
}
</datasource>
xml
<datasource lang="json5" mode="raw">
{
  "dataSourceType": "table",
  "dataSourceTableId": "student_profiles_table"
}
</datasource>

Zdroj dát typu tabuľka používa table, filter, sort, direction, realtime, limit, skip a output. Zdroj dát typu pole, JSON alebo CSV používa source.field alebo source.url. Pre každý kľúč zdroja dát, ktorý obalová forma nesprístupňuje, prejdite na mode="raw" a napíšte názvy polí, ktoré používa samotný runtime dokument.

Ostatných desať blokov stručne

Pomenované, opakovane použiteľné čítania. data/get/LoadStudentClasses.xu spája <params> (deklarované polia in/out) s <datasource>, takže komponent volá loader menom a sám nevlastní podrobnosti dotazu.

Pomenované zápisy. data/set/SaveStudentProfile.xu pridáva crudMode a allowCreate do <meta> vedľa parametrov a zdroja dát, čím dáva ukladaniu viditeľné, testovateľné miesto v zdroji.

Spracovanie záznam po zázname. data/batch/RebuildClassRoster.xu spustí krok <events> ako before_record nad každým riadkom, ktorý <datasource> vyhodnotí.

Blok <response> mení parametre, výsledky zdroja dát a udalosti na dáta v štýle JSON:

xml
<response>
({ ok: true, count: (@students_out || []).length, rows: @students_out })
</response>

Pomenovaná, opakovane použiteľná transformácia. <code> beží ako telo funkcie nad deklarovanými parametrami in a vracia hodnotu out:

xml
<code>
return (@raw_name_in || "")
  .trim()
  .toLowerCase()
  .replace(/\b\w/g, (letter) => letter.toUpperCase());
</code>

Opakovane použiteľná definícia správy, na ktorú sa odkazuje z pracovného postupu namiesto toho, aby sa zakaždým písala priamo:

xml
<alert lang="json5">
{
  alertDisplay: "toast",
  alertType: "success",
  alertTitle: "Student saved",
  createLog: false
}
</alert>
json5
{
  id: "student_profiles_table",
  menuTitle: "Student Profiles Table",
  fields: [
    { field_id: "student_id", type: "string" },
    { field_id: "full_name", type: "string" }
  ],
  indexes: [{ id: "campus_idx", name: "Campus", keys: ["campus"] }]
}
json5
{
  id: "app_route",
  menuTitle: "App Route",
  menu: [
    { title: "Overview", prog: "app" },
    { title: "Students", prog: "student_list" }
  ]
}

Trasy opisujú, ako sa komponenty prezentujú ako navigovateľná aplikácia; samotné komponenty nenahrádzajú.

json5
{
  id: "class_helper",
  menuTitle: "Class Helper",
  config: { provider: "openai", model: "gpt-5" }
}

Úplný príklad

xuda-studant-app-example je úplný zdrojový strom pokrývajúci všetkých jedenásť blokov: tok prihlásenia, dashboard so smerovaním, zoznam študentov, obrazovky úloh a profilu, čítania a zápisy nad tabuľkami a štýlovanie Tailwind. Rozbaľte ho pomocou:

bash
mkdir xuda-studant-app-example
cd xuda-studant-app-example
npm pack xuda-studant-app-example
tar -xzf xuda-studant-app-example-*.tgz --strip-components=1 package
rm xuda-studant-app-example-*.tgz
npm install
npm run dev
Existuje aj druhý dialekt pri zostavení

Všetko vyššie je interpretovaný dialekt, ktorý kompiluje xuda-cli: bloky parsované pri uložení do runtime dokumentov progUi / progFields / progEvents, ktoré číta renderer platformy riadený výrazmi. Samostatný, nepublikovaný kompilátor (@xuda/compiler, používaný vite-plugin-xu) číta užší súbor .xu zložený iba z <template>, <script> a <style>, ignoruje vyššie uvedené názvy blokov a vopred vydá skutočný modul ES namiesto dokumentu JSON. Mieri na novší renderer založený na signáloch v @xuda/core, rovnaký engine, aký platforma dodáva ako runtime/js/xuda_core.globals.js. Túto cestu nájdete v vite-plugin-xu a @xuda/core.