Zum Inhalt springen
Geprüft

Die .xu-Sprache

Das Blockformat, in dem jede .xu-Quelldatei geschrieben ist, und die elf Bausteine, aus denen ein Projekt besteht.

Eine .xu-Datei ist eine Blockdatei, kein JavaScript-Modul. Jeder Block ist ein Anliegen, und die Objektblöcke (<meta>, <params>, <fields>, <actions>, <events>, <datasource>) werden als Literale im JSON5-Stil geparst: Schlüssel ohne Anführungszeichen, Arrays und verschachtelte Objekte sind alle in Ordnung.

Elf Bausteine

Der Ordner, in dem eine Quelldatei liegt, bestimmt, zu welcher Art Einheit sie kompiliert wird. Eine gute Xu-App liest sich meist klarer, wenn jedes Anliegen seine eigene Einheit bekommt, statt dass eine Datei alles tut.

App.xu ist die eine reservierte Datei: Sie ist immer die Stamm-App und kompiliert immer zur Programm-ID app. Bei einer component-Datei wird die ID der Reihe nach aus meta.id, dann mount.id, dann dem eigenen Basisnamen der Datei aufgelöst. Jede andere Einheitenart hat keinen <mount>-Block, ihre ID wird also aus meta.id, dann dem eigenen Basisnamen der Datei aufgelöst. Bei den JSON5-Ressourcen lautet die Reihenfolge id, dann _id, dann Basisname. Doppelte IDs in einem Projekt sind nicht erlaubt.

Blöcke nach Einheitenart

App.xu braucht nie einen <mount>-Block. Eine gewöhnliche Komponente braucht nur dann einen, wenn du sie direkt in eine HTML-Seite einhängen willst, statt sie über <panel program="..."> zu erreichen:

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

Die Template-Sprache

Innerhalb von <template> kompiliert eine kleine Menge freundlicher Aliase zum eigenen xu-*-Markup der Laufzeit.

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>

Eine Komponente von Anfang bis Ende

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> kompiliert zu einem clientseitigen Mount-Modul: Der Default-Export erhält ein Kontextobjekt und kann eine Disposer-Funktion zurückgeben, die beim Entladen läuft. <style>-Blöcke werden zu einem ausgelieferten Komponenten-Stylesheet gesammelt.

Datasource-Format

Verwende innerhalb von <datasource lang="json5"> die lesbare Wrapper-Form. type ist eines von none, table, array, json oder 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>

Eine Tabellen-Datasource verwendet table, filter, sort, direction, realtime, limit, skip und output. Eine Array-, JSON- oder CSV-Datasource verwendet source.field oder source.url. Für jeden Datasource-Schlüssel, den die Wrapper-Form nicht bereitstellt, wechsle zu mode="raw" und schreibe die Feldnamen, die das Laufzeitdokument selbst verwendet.

Die anderen zehn Blöcke, kurz

Benannte, wiederverwendbare Lesevorgänge. data/get/LoadStudentClasses.xu kombiniert <params> (deklarierte in/out-Felder) mit einer <datasource>, sodass eine Komponente einen Loader über seinen Namen aufruft, statt die Abfragedetails selbst zu besitzen.

Benannte Schreibvorgänge. data/set/SaveStudentProfile.xu fügt <meta> neben den Parametern und der Datasource crudMode und allowCreate hinzu und gibt der Persistenz damit ein sichtbares, testbares Zuhause im Quelltext.

Datensatzweise Verarbeitung. data/batch/RebuildClassRoster.xu führt einen <events>-Schritt wie before_record für jede Zeile aus, die die <datasource> liefert.

Ein <response>-Block macht aus Parametern, Datasource-Ergebnissen und Events eine Nutzlast im JSON-Stil:

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

Eine benannte, wiederverwendbare Transformation. <code> läuft als Funktionsrumpf über den deklarierten in-Parametern und gibt den out-Wert zurück:

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

Eine wiederverwendbare Nachrichtendefinition, auf die ein Workflow verweist, statt dass sie jedes Mal inline geschrieben wird:

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" }
  ]
}

Routen beschreiben, wie Komponenten als navigierbare App dargestellt werden; sie ersetzen die Komponenten selbst nicht.

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

Ein vollständiges Beispiel

xuda-studant-app-example ist ein vollständiger Quellbaum, der alle elf Bausteine abdeckt: einen Login-Ablauf, ein geroutetes Dashboard, Schülerliste, Aufgaben- und Profilbildschirme, tabellengestützte Lese- und Schreibvorgänge und Tailwind-Styling. Entpacke es mit:

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
Es gibt auch einen zweiten Dialekt zur Build-Zeit

Alles oben Beschriebene ist der interpretierte Dialekt, den xuda-cli kompiliert: Blöcke, die beim Speichern zu Laufzeitdokumenten progUi / progFields / progEvents geparst und vom ausdrucksgesteuerten Renderer der Plattform gelesen werden. Ein separater, unveröffentlichter Compiler (@xuda/compiler, verwendet von vite-plugin-xu) liest eine schmalere .xu-Datei, die nur aus <template>, <script> und <style> besteht, ignoriert die oben genannten Blocknamen und gibt vorab ein echtes ES-Modul statt eines JSON-Dokuments aus. Er zielt auf den neueren Signals-basierten Renderer in @xuda/core, dieselbe Engine, die die Plattform als runtime/js/xuda_core.globals.js ausliefert. Siehe vite-plugin-xu und @xuda/core für diesen Weg.