Hoppa till innehållet
Verifierad

.xu-språket

Blockformatet som varje .xu-källfil skrivs i, och de elva byggstenar som ett projekt består av.

En .xu-fil är en blockfil, inte en JavaScript-modul. Varje block är ett ansvarsområde, och objektblocken (<meta>, <params>, <fields>, <actions>, <events>, <datasource>) tolkas som literaler i JSON5-stil: citattecken kring nycklar behövs inte, och listor och nästlade objekt går bra.

Elva byggstenar

Mappen som en källfil ligger i avgör vilken sorts enhet den kompileras till. En bra Xu-app blir ofta tydligare att läsa när varje ansvarsområde får en egen enhet i stället för att en fil gör allt.

App.xu är den enda reserverade filen: den är alltid rotappen och kompileras alltid till program-id app. För en component-fil löses id:t i ordning från meta.id, sedan mount.id, sedan filens eget basnamn. Alla andra enhetstyper har inget <mount>-block, så deras id löses från meta.id och sedan filens eget basnamn. För JSON5-resurserna är ordningen id, sedan _id, sedan basnamn. Dubbla id:n i ett projekt är inte tillåtna.

Block per enhetstyp

App.xu behöver aldrig ett <mount>-block. En vanlig komponent behöver ett bara när du vill att den ska monteras direkt i en HTML-sida i stället för att nås via <panel program="...">:

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

Mallspråket

Inuti <template> kompileras en liten uppsättning vänliga alias ned till runtime:s 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, från början till slut

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> kompileras till en monteringsmodul på klientsidan: standardexporten tar emot ett kontextobjekt och kan returnera en avslutsfunktion som körs vid nedladdning. <style>-block samlas i ett enda serverat stilark för komponenten.

Datakälleformat

Använd den läsbara omslagsformen inuti <datasource lang="json5">. type är en av 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 tabelldatakälla använder table, filter, sort, direction, realtime, limit, skip och output. En array-, JSON- eller CSV-datakälla använder source.field eller source.url. För varje datakällenyckel som omslagsformen inte exponerar växlar du till mode="raw" och skriver de fältnamn som själva runtime-dokumentet använder.

De andra tio blocken, kort

Namngivna, återanvändbara läsningar. data/get/LoadStudentClasses.xu parar <params> (deklarerade in-/out-fält) med en <datasource>, så att en komponent anropar en hämtare vid namn i stället för att själv äga frågedetaljerna.

Namngivna skrivningar. data/set/SaveStudentProfile.xu lägger till crudMode och allowCreate i <meta> vid sidan av params och datakälla, vilket ger lagringen ett synligt, testbart hem i källkoden.

Post-för-post-bearbetning. data/batch/RebuildClassRoster.xu kör ett <events>-steg som before_record mot varje rad som <datasource> ger.

Ett <response>-block gör params, datakällresultat och händelser till en nyttolast i JSON-stil:

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

En namngiven, återanvändbar omvandling. <code> körs som en funktionskropp över de deklarerade in-parametrarna och returnerar out-värdet:

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

En återanvändbar meddelandedefinition som refereras från ett arbetsflöde i stället för att skrivas inline varje gång:

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

Rutter beskriver hur komponenter presenteras som en navigerbar app; de ersätter inte själva komponenterna.

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

Ett fullständigt exempel

xuda-studant-app-example är ett komplett källträd som täcker alla elva block: ett inloggningsflöde, en dirigerad instrumentpanel, elevlista, uppgifts- och profilskärmar, tabellbaserade läsningar och skrivningar samt Tailwind-formgivning. Packa upp det 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
Det finns även en andra dialekt för byggtid

Allt ovan är den tolkade dialekt som xuda-cli kompilerar: block som tolkas vid sparande till runtime-dokumenten progUi / progFields / progEvents, som läses av plattformens uttrycksdrivna renderare. En separat, opublicerad kompilator (@xuda/compiler, som används av vite-plugin-xu) läser en snävare .xu-fil som bara består av <template>, <script> och <style>, ignorerar blocknamnen ovan och skapar en riktig ES-modul i förväg i stället för ett JSON-dokument. Den riktar sig mot den nyare signalbaserade renderaren i @xuda/core, samma motor som plattformen levererar som runtime/js/xuda_core.globals.js. Se vite-plugin-xu och @xuda/core för den vägen.