Gå til indhold
Bekræftet

.xu-sproget

Blokformatet, som hver .xu-kildefil er skrevet i, og de elleve byggeklodser, et projekt består af.

En .xu-fil er en blokfil, ikke et JavaScript-modul. Hver blok er ét anliggende, og objektblokkene (<meta>, <params>, <fields>, <actions>, <events>, <datasource>) parses som literaler i JSON5-stil: nøgler uden anførselstegn, arrays og indlejrede objekter er alle i orden.

Elleve byggeklodser

Den mappe, en kildefil ligger i, afgør, hvilken slags enhed den kompileres til. En god Xu-app er som regel lettere at læse, når hvert anliggende får sin egen enhed i stedet for, at én fil gør det hele.

App.xu er den ene reserverede fil: den er altid rod-appen og kompileres altid til program-id'et app. For en component-fil løses id'et i rækkefølge fra meta.id, så mount.id og så filens eget basisnavn. Alle andre enhedstyper har ingen <mount>-blok, så deres id løses fra meta.id og så filens eget basisnavn. For JSON5-ressourcerne er rækkefølgen id, så _id, så basisnavn. Dublerede id'er i et projekt er ikke tilladt.

Blokke pr. enhedstype

App.xu behøver aldrig en <mount>-blok. En almindelig komponent har kun brug for en, når du vil have den monteret direkte i en HTML-side i stedet for at nå den gennem <panel program="...">:

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

Skabelonsproget

Inde i <template> kompileres et lille sæt venlige aliasser ned til runtime'ens egen xu-*-markup.

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>

En komponent fra ende til anden

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> kompileres til et monteringsmodul på klientsiden: standardeksporten modtager et kontekstobjekt og kan returnere en oprydningsfunktion, der køres ved aflæsning. <style>-blokke samles i ét serveret stilark for komponenten.

Datakildeformat

Brug den læsbare indpakningsform inde i <datasource lang="json5">. type er en af none, table, array, json eller 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>

En tabeldatakilde bruger table, filter, sort, direction, realtime, limit, skip og output. En array-, JSON- eller CSV-datakilde bruger source.field eller source.url. For en datakildenøgle, som indpakningsformen ikke udstiller, skal du skifte til mode="raw" og skrive de feltnavne, som runtime-dokumentet selv bruger.

De andre ti blokke kort

Navngivne, genbrugelige læsninger. data/get/LoadStudentClasses.xu parrer <params> (erklærede in/out-felter) med en <datasource>, så en komponent kalder en indlæser ved navn i stedet for selv at eje forespørgselsdetaljerne.

Navngivne skrivninger. data/set/SaveStudentProfile.xu tilføjer crudMode og allowCreate til <meta> ved siden af params og datakilde, så lagring får et synligt, testbart hjem i kilden.

Behandling post for post. data/batch/RebuildClassRoster.xu kører et <events>-trin som before_record mod hver række, som <datasource> giver.

En <response>-blok gør params, datakilderesultater og hændelser til en nyttelast i JSON-stil:

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

En navngivet, genbrugelig transformation. <code> køres som en funktionskrop over de erklærede in-params og returnerer out-værdien:

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

En genbrugelig beskeddefinition, der refereres til fra en workflow i stedet for at blive skrevet direkte ind hver gang:

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

Ruter beskriver, hvordan komponenter præsenteres som en app, man kan navigere i. De erstatter ikke selve komponenterne.

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

Et fuldt eksempel

xuda-studant-app-example er et komplet kildetræ, der dækker alle elleve blokke: et loginforløb, et dashboard med ruter, elevliste, opgave- og profilskærme, læsning og skrivning mod tabeller og Tailwind-styling. Pak det ud med:

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
Der findes også en anden dialekt på build-tidspunktet

Alt ovenfor er den fortolkede dialekt, som xuda-cli kompilerer: blokke, der parses ved gemning til runtime-dokumenterne progUi / progFields / progEvents, som platformens udtryksdrevne renderer læser. En separat, ikke udgivet kompiler (@xuda/compiler, brugt af vite-plugin-xu) læser en snævrere .xu-fil, der kun består af <template>, <script> og <style>, ignorerer blokkenavnene ovenfor og udsender et rigtigt ES-modul på forhånd i stedet for et JSON-dokument. Den retter sig mod den nyere signalbaserede renderer i @xuda/core, den samme motor, som platformen leverer som runtime/js/xuda_core.globals.js. Se vite-plugin-xu og @xuda/core for den vej.