Siirry sisältöön
Tarkistettu

.xu-kieli

Lohkomuoto, jolla jokainen .xu-lähdetiedosto kirjoitetaan, ja yksitoista rakennuspalikkaa, joista projekti koostuu.

.xu-tiedosto on lohkotiedosto, ei JavaScript-moduuli. Kukin lohko on yksi asia, ja oliolohkot (<meta>, <params>, <fields>, <actions>, <events>, <datasource>) jäsennetään JSON5-tyylisinä literaaleina: lainaukseton avain, taulukot ja sisäkkäiset oliot kelpaavat kaikki.

Yksitoista rakennuspalikkaa

Kansio, jossa lähdetiedosto sijaitsee, määrää, minkälaiseksi yksiköksi se kääntyy. Hyvä Xu-sovellus on yleensä selkeämpi, kun jokainen asia saa oman yksikkönsä sen sijaan, että yksi tiedosto tekisi kaiken.

App.xu on ainoa varattu tiedosto: se on aina juurisovellus ja kääntyy aina ohjelmatunnisteeksi app. component-tiedostolle tunniste ratkaistaan järjestyksessä arvosta meta.id, sitten mount.id, sitten tiedoston oma perusnimi. Mikään muu yksikkötyyppi ei sisällä <mount>-lohkoa, joten sen tunniste ratkaistaan arvosta meta.id ja sitten tiedoston omasta perusnimestä. JSON5-resursseille järjestys on id, sitten _id, sitten perusnimi. Päällekkäiset tunnisteet projektissa eivät ole sallittuja.

Lohkot yksikkötyypeittäin

App.xu ei koskaan tarvitse <mount>-lohkoa. Tavallinen komponentti tarvitsee sellaisen vain, kun haluat liittää sen suoraan HTML-sivulle sen sijaan, että siihen päästäisiin <panel program="...">:n kautta:

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

Mallikieli

<template>:n sisällä pieni joukko ystävällisiä aliaksia kääntyy suoritusympäristön omaksi xu-*-merkinnäksi.

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>

Komponentti alusta loppuun

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> kääntyy asiakaspuolen liitosmoduuliksi: oletusvienti saa kontekstiolion ja voi palauttaa hävitysfunktion, joka ajetaan purettaessa. <style>-lohkot kerätään yhdeksi tarjoiltavaksi komponentin tyylitiedostoksi.

Datalähteen muoto

Käytä luettavaa kääremuotoa <datasource lang="json5">:n sisällä. type on yksi arvoista none, table, array, json tai 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>

Taulun datalähde käyttää avaimia table, filter, sort, direction, realtime, limit, skip ja output. Array-, JSON- tai CSV-datalähde käyttää avainta source.field tai source.url. Jos tarvitset datalähteen avaimen, jota kääre ei tarjoa, siirry tilaan mode="raw" ja kirjoita kenttien nimet sellaisina kuin suoritusaikainen dokumentti itse niitä käyttää.

Muut kymmenen lohkoa lyhyesti

Nimetyt, uudelleenkäytettävät lukemiset. data/get/LoadStudentClasses.xu yhdistää <params>:n (ilmoitetut in/out-kentät) ja <datasource>:n, joten komponentti kutsuu lataajaa nimellä sen sijaan, että omistaisi kyselyn yksityiskohdat itse.

Nimetyt kirjoitukset. data/set/SaveStudentProfile.xu lisää crudMode- ja allowCreate-arvot <meta>:an parametrien ja datalähteen rinnalle, antaen tallennukselle näkyvän, testattavan kodin lähteessä.

Tietue kerrallaan -käsittely. data/batch/RebuildClassRoster.xu ajaa <events>-vaiheen, kuten before_record, jokaiselle riville, jonka <datasource> ratkaisee.

<response>-lohko muuttaa parametrit, datalähteen tulokset ja tapahtumat JSON-tyyliseksi payloadiksi:

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

Nimetty, uudelleenkäytettävä muunnos. <code> ajetaan funktion runkona ilmoitettujen in-parametrien yli ja palauttaa out-arvon:

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

Uudelleenkäytettävä viestimääritys, johon viitataan työnkulusta sen sijaan, että se kirjoitettaisiin sisäisesti joka kerta:

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

Reitit kuvaavat, miten komponentit esitetään selattavana sovelluksena. Ne eivät korvaa itse komponentteja.

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

Täysi esimerkki

xuda-studant-app-example on täydellinen lähdepuu, joka kattaa kaikki yksitoista lohkoa: kirjautumisvirta, reititetty kojelauta, oppilasluettelo, tehtävä- ja profiilinäkymät, taulupohjaiset lukemiset ja kirjoitukset sekä Tailwind-tyylit. Pura se komennoilla:

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
Olemassa on myös toinen, koontiaikainen murre

Kaikki yllä oleva on tulkittu murre, jonka xuda-cli kääntää: lohkot jäsennetään tallennettaessa progUi / progFields / progEvents -suoritusaikaisiksi dokumenteiksi, jotka alustan lausekeohjattu renderöijä lukee. Erillinen, julkaisematon kääntäjä (@xuda/compiler, jota vite-plugin-xu käyttää) lukee suppeamman .xu-tiedoston, jossa on vain <template>, <script> ja <style>, ei huomioi yllä olevia lohkonimiä ja tuottaa JSON-dokumentin sijaan oikean ES-moduulin etukäteen. Se kohdistuu @xuda/core:n uudempaan signaalipohjaiseen renderöijään, samaan moottoriin, jonka alusta toimittaa tiedostona runtime/js/xuda_core.globals.js. Katso vite-plugin-xu ja @xuda/core kyseisestä polusta.