Przejdź do treści
Zweryfikowano

Język .xu

Format blokowy, w którym pisany jest każdy plik źródłowy .xu, i jedenaście elementów składowych projektu.

Plik .xu to plik blokowy, a nie moduł JavaScript. Każdy blok to jedna sprawa, a bloki obiektowe (<meta>, <params>, <fields>, <actions>, <events>, <datasource>) są parsowane jako literały w stylu JSON5: klucze bez cudzysłowów, tablice i zagnieżdżone obiekty są w porządku.

Jedenaście elementów składowych

Folder, w którym leży plik źródłowy, decyduje o tym, do jakiego rodzaju jednostki się skompiluje. Aplikacja Xu zwykle czyta się lepiej, gdy każda sprawa ma własną jednostkę, a nie jeden plik robi wszystko.

App.xu to jedyny zarezerwowany plik: zawsze jest główną aplikacją i zawsze kompiluje się do identyfikatora programu app. Dla pliku component identyfikator jest ustalany kolejno z meta.id, potem z mount.id, a potem z nazwy bazowej samego pliku. Każdy inny typ jednostki nie ma bloku <mount>, więc jego identyfikator wynika z meta.id, a potem z nazwy bazowej pliku. W zasobach JSON5 kolejność to id, potem _id, potem nazwa bazowa. Duplikaty identyfikatorów w projekcie są niedozwolone.

Bloki według typu jednostki

App.xu nigdy nie potrzebuje bloku <mount>. Zwykły komponent potrzebuje go tylko wtedy, gdy chcesz zamontować go bezpośrednio na stronie HTML, a nie docierać do niego przez <panel program="...">:

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

Język szablonów

Wewnątrz <template> niewielki zestaw przyjaznych aliasów kompiluje się do własnego znacznika xu-* środowiska uruchomieniowego.

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 początku do końca

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> kompiluje się do modułu montowania po stronie klienta: eksport domyślny otrzymuje obiekt kontekstu i może zwrócić funkcję zwalniającą, uruchamianą przy zwolnieniu. Bloki <style> są zbierane w jeden serwowany arkusz stylów komponentu.

Format źródła danych

Używaj czytelnej formy z opakowaniem wewnątrz <datasource lang="json5">. type to jedno z none, table, array, json lub 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>

Źródło danych typu tabela używa table, filter, sort, direction, realtime, limit, skip i output. Źródło danych typu tablica, JSON lub CSV używa source.field lub source.url. Dla każdego klucza źródła danych, którego forma z opakowaniem nie udostępnia, przejdź na mode="raw" i zapisz nazwy pól, których używa sam dokument uruchomieniowy.

Pozostałe dziesięć bloków w skrócie

Nazwane odczyty wielokrotnego użytku. data/get/LoadStudentClasses.xu łączy <params> (zadeklarowane pola in/out) z <datasource>, więc komponent wywołuje loader po nazwie, a nie sam zarządza szczegółami zapytania.

Nazwane zapisy. data/set/SaveStudentProfile.xu dodaje crudMode i allowCreate do <meta> obok parametrów i źródła danych, dając trwałemu zapisowi widoczne, testowalne miejsce w kodzie źródłowym.

Przetwarzanie rekord po rekordzie. data/batch/RebuildClassRoster.xu uruchamia krok <events>, taki jak before_record, dla każdego wiersza, który zwraca <datasource>.

Blok <response> zamienia parametry, wyniki źródła danych i zdarzenia w ładunek w stylu JSON:

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

Nazwane przekształcenie wielokrotnego użytku. <code> działa jako ciało funkcji na zadeklarowanych parametrach in i zwraca wartość out:

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

Definicja komunikatu wielokrotnego użytku, przywoływana z przepływu pracy zamiast pisania jej za każdym razem w treści:

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ą, jak komponenty są prezentowane jako aplikacja z nawigacją; nie zastępują samych komponentów.

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

Pełny przykład

xuda-studant-app-example to kompletne drzewo źródeł obejmujące wszystkie jedenaście bloków: przepływ logowania, pulpit z trasami, listę studentów, ekrany zadań i profilu, odczyty i zapisy oparte na tabelach oraz stylowanie Tailwind. Rozpakuj go poleceniami:

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
Istnieje też drugi dialekt, działający w czasie budowania

Wszystko powyżej to dialekt interpretowany, który kompiluje xuda-cli: bloki parsowane przy zapisie do dokumentów uruchomieniowych progUi / progFields / progEvents, czytanych przez renderer platformy sterowany wyrażeniami. Osobny, nieopublikowany kompilator (@xuda/compiler, używany przez vite-plugin-xu) czyta węższy plik .xu złożony wyłącznie z <template>, <script> i <style>, ignoruje nazwy bloków podane wyżej i z wyprzedzeniem emituje prawdziwy moduł ES zamiast dokumentu JSON. Jest przeznaczony dla nowszego renderera opartego na sygnałach w @xuda/core, tym samym silniku, który platforma dostarcza jako runtime/js/xuda_core.globals.js. Zobacz vite-plugin-xu i @xuda/core, żeby poznać tę ścieżkę.