Ugrás a tartalomhoz
Ellenőrizve

A .xu nyelv

A blokkformátum, amelyben minden .xu forrásfájl íródik, és a tizenegy építőelem, amelyből egy projekt áll.

A .xu fájl blokkfájl, nem JavaScript-modul. Minden blokk egy-egy feladatkör, az objektumblokkokat (<meta>, <params>, <fields>, <actions>, <events>, <datasource>) pedig JSON5-stílusú literálként értelmezi: idézőjel nélküli kulcsok, tömbök és beágyazott objektumok mind rendben vannak.

Tizenegy építőelem

Az dönti el, milyen egységgé fordul egy forrásfájl, hogy melyik mappában van. Egy jó Xu alkalmazás általában áttekinthetőbb, ha minden feladatkör külön egységet kap ahelyett, hogy egy fájl csinálna mindent.

Az App.xu az egyetlen fenntartott fájl: mindig ez a gyökéralkalmazás, és mindig az app programazonosítóra fordul. Egy component fájl azonosítója sorrendben a meta.id, majd a mount.id, majd a fájl saját alapneve alapján oldódik fel. Minden más egységtípusnak nincs <mount> blokkja, így az azonosítója a meta.id, majd a fájl saját alapneve alapján oldódik fel. A JSON5 erőforrásoknál a sorrend id, majd _id, majd alapnév. Az azonosítók ismétlődése egy projekten belül nem engedélyezett.

Blokkok egységtípusonként

Az App.xu-nak soha nincs szüksége <mount> blokkra. Egy hétköznapi komponensnek csak akkor kell, ha közvetlenül egy HTML-oldalba szeretné csatolni, ahelyett hogy <panel program="..."> útján érné el:

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

A sablonnyelv

A <template> belsejében néhány barátságos alias a futtatókörnyezet saját xu-* jelölésére fordul.

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>

Egy komponens az elejétől a végéig

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>

A <script> egy kliensoldali csatolási modulba fordul: az alapértelmezett export egy kontextusobjektumot kap, és visszaadhat egy felszámoló függvényt, amely kiürítéskor lefut. A <style> blokkok egyetlen, kiszolgált komponensstíluslapba gyűlnek.

Az adatforrás formátuma

Használja az olvasható burkolóformát a <datasource lang="json5"> belsejében. A type értéke none, table, array, json vagy csv lehet.

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>

A táblaadatforrás a table, filter, sort, direction, realtime, limit, skip és output kulcsokat használja. A tömb-, JSON- vagy CSV-adatforrás a source.field vagy a source.url kulcsot használja. Minden olyan adatforráskulcshoz, amelyet a burkolóforma nem tesz elérhetővé, váltson mode="raw" módra, és írja azokat a mezőneveket, amelyeket maga a futásidejű dokumentum használ.

A másik tíz blokk röviden

Elnevezett, újrafelhasználható olvasások. A data/get/LoadStudentClasses.xu a <params> blokkot (deklarált in/out mezők) párosítja egy <datasource> blokkal, így a komponens név szerint hív egy betöltőt, ahelyett hogy a lekérdezés részleteit maga birtokolná.

Elnevezett írások. A data/set/SaveStudentProfile.xu a <meta> blokkhoz hozzáadja a crudMode és allowCreate kulcsot a paraméterek és az adatforrás mellett, így a mentés látható, tesztelhető helyet kap a forrásban.

Rekordonkénti feldolgozás. A data/batch/RebuildClassRoster.xu egy <events> lépést, például a before_record eseményt futtat minden soron, amelyet a <datasource> feloldott.

Egy <response> blokk a paramétereket, az adatforrás eredményeit és az eseményeket JSON-stílusú adattartalommá alakítja:

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

Elnevezett, újrafelhasználható átalakítás. A <code> függvénytörzsként fut a deklarált in paramétereken, és az out értéket adja vissza:

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

Újrafelhasználható üzenetdefiníció, amelyre egy munkafolyamatból hivatkozik, ahelyett hogy minden alkalommal beírná:

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

Az útvonalak azt írják le, hogyan jelennek meg a komponensek navigálható alkalmazásként; nem helyettesítik magukat a komponenseket.

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

Egy teljes példa

Az xuda-studant-app-example egy teljes forrásfa, amely mind a tizenegy blokkot lefedi: bejelentkezési folyamat, útvonalas irányítópult, diáklista, feladat- és profilképernyők, táblára épülő olvasások és írások, valamint Tailwind stílusozás. Így csomagolhatja ki:

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
Létezik egy második, build idejű dialektus is

Minden fent leírt dolog az az értelmezett dialektus, amelyet az xuda-cli fordít: a blokkokat mentéskor progUi / progFields / progEvents futásidejű dokumentumokká elemzi, amelyeket a platform kifejezésvezérelt megjelenítője olvas. Egy különálló, nem publikált fordító (@xuda/compiler, a vite-plugin-xu használja) egy szűkebb, csak <template>, <script> és <style> blokkokból álló .xu fájlt olvas, figyelmen kívül hagyja a fenti blokkneveket, és JSON-dokumentum helyett előre valódi ES-modult állít elő. Az @xuda/core újabb, jelekre épülő megjelenítőjét célozza, ugyanazt a motort, amelyet a platform runtime/js/xuda_core.globals.js néven szállít. Erről az útról lásd a vite-plugin-xu és az @xuda/core oldalt.