Pereiti prie turinio

Komponentai

Blockstudio pateikia 59 UI komponentų su kiekviena versija. Jie užregistruojami automatiškai, formatuojami naudojant dizaino žetonus ir kuriami naudojant tokią pačią žymų sintaksę kaip bet kuris kitas blokas.

Blockstudio 7.3 versijoje yra rinkinys sujungtų, be išankstinio dizaino UI blokų, veikiančių su WordPress Interactivity API. Jie registruojami bsui/* vardų srityje ir gali būti naudojami šablonuose, failais pagrįstuose puslapiuose, šablonų rinkiniuose ir įrašų turinyje.

Pastaba

UI komponentai yra beta versijos, kol renkame atsiliepimus apie jų rinkinį, pavadinimus, veikimą ir naudojimo projektuose būdus. Juos galima išbandyti 7.3 versijoje, tačiau API sąsaja dar gali būti tobulinama, kol bus paskelbta stabilia.

Įjungti UI komponentus

Sujungti UI komponentai įjungiami pasirinktinai. Įjunkite juos savo temos blockstudio.json:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "ui": {
    "enabled": true
  }
}

Arba įjunkite juos naudodami filtrą:

PHP
add_filter('blockstudio/settings/ui/enabled', '__return_true');

Įjungus, Blockstudio užregistruoja sujungtą komponentų biblioteką iš includes/ui/blocks.

Viešas katalogas ir pavyzdžiai

Sujungti įgyvendinimo blokai lieka įprastomis bsui/* registracijomis, tačiau kurdami komponentų galeriją naudokite viešąjį šeimų katalogą:

PHP
use Blockstudio\Ui;

$families = Ui::inventory();
$examples = Ui::examples();

Ui::inventory() sugrupuoja kiekvieną sudėtinį komponentą pagal jo viešąjį pagrindinį bloką ir išvardija tai šeimai reikalingas įgyvendinimo registracijas. Ui::examples() prideda deterministinį, normalizuotą aprašą su numatytaisiais ir pavyzdiniais duomenimis. Jis išsaugo reikalingus pagrindinio ir antrinių blokų ryšius, todėl rezultatą galima tiesiogiai perduoti į Blockstudio\Render::document().

Viešame Canvas kataloge šie pavyzdžiai pateikiami naudojant tipą ui, o sujungtos įgyvendinimo registracijos praleidžiamos iš įprasto tipo blocks. Taip gaunamas vienas visas kiekvienos viešosios komponentų šeimos pavyzdys, o ne vidinių pagrindinių blokų, aktyviklių, iššokančių langų ir sluoksnių fragmentų galerija.

Surenkant jau atvaizduotą dokumentą, Ui::global_assets($block_names, $html) pateikia tikslų sujungtąjį visuotinį stilių ir scenarijų tik tada, kai pasirinktoje išvestyje iš tikrųjų naudojamas UI komponentas.

Atvaizdavimas

Naudokite įprastą bloko žymos sintaksę:

HTML
<block name="bsui/button" label="Save" variant="default"></block>

Tinka ir trumpesnė sintaksė <bs:>:

HTML
<bs:bsui-button label="Save" variant="default" />

Blockstudio šablonuose blokų žymos atvaizduojamos automatiškai. Failais pagrįstuose puslapiuose ir šablonų rinkiniuose jos sinchronizuojamos kaip vietiniai WordPress blokai. Jei norite tiesiogiai atvaizduoti UI komponentus iš įrašų turinio arba valdiklių sričių, įjunkite puslapio lygmens blokų žymas:

JSON
{
  "ui": {
    "enabled": true
  },
  "blockTags": {
    "enabled": true,
    "allow": ["bsui/*", "app/*"]
  }
}

Pagrindiniai komponentai

Paprasti komponentai atvaizduojami kaip vienas blokas:

HTML
<block name="bsui/button" label="Continue" variant="default"></block>
<block name="bsui/badge" label="Beta"></block>
<block
  name="bsui/input"
  nameAlt="email"
  type="email"
  placeholder="Email"
></block>
<block name="bsui/textarea" name="message" placeholder="Message"></block>
<block name="bsui/spinner"></block>

Atributai tiesiogiai susiejami su kiekvieno komponento block.json atributais. Pavyzdžiui, bsui/button palaiko label, icon, iconPosition, href, variant, size ir disabled.

PHP
bs_render_block([
  'name' => 'bsui/button',
  'data' => [
    'label' => 'Continue',
    'icon' => [
      'set' => 'heroicons',
      'subSet' => 'outline',
      'icon' => 'arrow-right',
    ],
    'iconPosition' => 'right',
  ],
]);

Sudėtiniai komponentai

Daugelį UI komponentų sudaro keli blokai. Pagrindinis blokas valdo būseną, o antriniai nurodo savo pirminį bloką.

Skirtukai

HTML
<block name="bsui/tabs" defaultValue="tab1">
  <block name="bsui/tabs-list">
    <block name="bsui/tabs-trigger" value="tab1" title="Features"></block>
    <block name="bsui/tabs-trigger" value="tab2" title="Pricing"></block>
    <block name="bsui/tabs-trigger" value="tab3" title="FAQ"></block>
  </block>
  <block name="bsui/tabs-panel" value="tab1">
    <p>Features content.</p>
  </block>
  <block name="bsui/tabs-panel" value="tab2">
    <p>Pricing content.</p>
  </block>
  <block name="bsui/tabs-panel" value="tab3">
    <p>FAQ content.</p>
  </block>
</block>

Dialogas

HTML
<block name="bsui/dialog">
  <block name="bsui/dialog-trigger" label="Open Dialog"></block>
  <block name="bsui/dialog-backdrop"></block>
  <block name="bsui/dialog-popup">
    <p>Dialog content.</p>
    <block name="bsui/dialog-close" label="Close"></block>
  </block>
</block>

Pasirinkimo sąrašas

HTML
<block name="bsui/select" placeholder="Choose a fruit" nameAlt="fruit">
  <block name="bsui/select-trigger"></block>
  <block name="bsui/select-popup">
    <block name="bsui/select-option" value="apple" label="Apple"></block>
    <block name="bsui/select-option" value="banana" label="Banana"></block>
    <block name="bsui/select-option" value="cherry" label="Cherry"></block>
  </block>
</block>

Formos laukai

HTML
<block name="bsui/form" block="contact/form" successMessage="Thank you!">
  <block name="bsui/field">
    <block name="bsui/field-label" text="Email"></block>
    <block name="bsui/input" nameAlt="email" type="email"></block>
    <block name="bsui/field-error"></block>
  </block>
</block>

Galimi blokai

Sujungtoje UI bibliotekoje yra:

Sritis Blokai
Išdėstymas bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table
Veiksmai bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar
Įvestys bsui/checkbox, bsui/color-picker, bsui/date-input, bsui/file-upload, bsui/input, bsui/number-field, bsui/otp-input, bsui/password-input, bsui/phone-input, bsui/radio-group, bsui/rating, bsui/select, bsui/slider, bsui/switch, bsui/textarea, bsui/time-picker
Perdangos bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip
Navigacija bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs
Grįžtamasis ryšys bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast
Formos bsui/field, bsui/field-group, bsui/form

Sudėtiniai komponentai taip pat pateikia antrinius blokus, pvz., bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup ir bsui/select-option.

Stiliai

UI komponentai turi savas CSS tinkintąsias savybes su prefiksu --bs-ui-*. Galite jas perrašyti savo temos CSS:

CSS
:root {
  --bs-ui-radius: 0.5rem;
  --bs-ui-primary: oklch(0.45 0.18 260);
  --bs-ui-primary-foreground: white;
}

Komponentų veikimas nėra iš anksto apibrėžtas, tačiau jų nuostatos pakankamai aiškios, kad juos būtų galima naudoti iš karto. Pirmiausia perrašykite žetonus, o tada, jei reikia, pridėkite konkrečiam komponentui skirtų CSS.

Sujungtų komponentų CSS pateikiami nurodytame bsui pakopiniame sluoksnyje. Nepakopinis temos CSS gali perrašyti komponentų taisykles nenaudojant !important:

CSS
.button-brand {
  background: var(--brand-primary);
}

Norėdami pridėti tinkintą bsui/button variantą, naudodami esamą atributų filtrą pridėkite pasirinkimo parinktį ir pateikite varianto CSS su blockstudio/ui/button/variants-style:

PHP
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
  if (($block['name'] ?? '') === 'bsui/button' && ($attribute['id'] ?? '') === 'variant') {
    $attribute['options'][] = [
      'label' => 'Brand',
      'value' => 'brand',
    ];
  }

  return $attribute;
}, 10, 2);

add_filter('blockstudio/ui/button/variants-style', function($css) {
  return $css . '
[data-bsui-button][data-variant="brand"] {
  background: var(--brand-primary);
  color: white;
}';
});

Visi komponentai

Išskleidžiamas sąrašas Vertikaliai sudėti skyriai, po vieną išskleidžiantys skydelį. Įspėjimo dialogas Modalinis langas, pertraukiantis veiksmų eigą ir prieš užsidarydamas reikalaujantis atsakymo. Kraštinių santykis Užfiksuoja turinį pagal nustatytą pločio ir aukščio santykį. Avataras Naudotojo vaizdas, kurio nepavykus įkelti rodomi inicialai. Ženklelis Nedidelė etiketė būsenai, skaičiams ir kategorijoms. Naršymo kelias Parodo dabartinio puslapio vietą hierarchijoje. Mygtukas Atlieka veiksmą ir siūlo skirtingo išraiškingumo variantus. Mygtukų grupė Sujungia susijusius mygtukus į vieną segmentuotą valdiklį. Kalendorius Datos tinklelis vienai dienai pasirinkti. Kortelė Sritis, jungianti antraštę, turinį ir poraštę. Karuselė Slenkamas skaidrių takelis su klaviatūros palaikymu. Žymimasis langelis Dvejetainio pasirinkimo valdiklis, palaikantis ir neapibrėžtą būseną. Suskleidžiamas Paslepia ir parodo vieną turinio sritį. Spalvų parinkiklis Leidžia pasirinkti spalvą ir pateikia ją kartu su aplinkine forma. Kombinuotasis laukelis Teksto įvesties laukas, filtruojantis parinkčių sąrašą jums rašant. Kontekstinis meniu Veiksmai, rodomi spustelėjus dešiniuoju pelės mygtuku ir pririšti prie žymeklio. Datos įvesties laukas Kauke apsaugotas laukas datoms įvesti be parinkiklio. Dialogas Modalinis sluoksnis tikslinėms užduotims ir patvirtinimams. Iš šono atveriamas skydelis Skydelis, įvažiuojantis iš bet kurio ekrano krašto. Laukas Apgaubia valdiklį etikete, aprašu ir klaidos pranešimu. Laukų grupė Grupuoja susijusius laukus po bendra antrašte. Failo įkėlimas Failų įkėlimo sritis ir parinkiklis, palaikantis kelis failus. Forma Pateikia laukų duomenis ir praneša apie sėkmę neįkeldamas puslapio iš naujo. Įvestis Vienos eilutės teksto laukas visiems įprastiems įvesties tipams. Spartusis klavišas Rodo klaviatūros spartųjį klavišą atskirame klavišo laukelyje. Žyma Valdiklio antraštė, bendra visiems komponentams su etiketėmis. Meniu Išskleidžiamasis veiksmų sąrašas, pririštas prie aktyvinimo elemento. Meniu juosta Horizontali meniu juosta, kaip darbalaukio programoje. Matuoklis Rodo matavimą žinomame intervale. Naršymo meniu Svetainės naršymas su įdėtinėmis nuorodomis ir užvedus pelės žymeklį atveriamais skydeliais. Skaičiaus laukas Skaitinė įvestis su žingsniavimo mygtukais ir apribotu intervalu. OTP įvesties laukas Atskiri langeliai vienkartiniam kodui įvesti. Puslapių numeravimas Puslapių nuorodos su ankstesniu, kitu puslapiu ir praleidimų žymomis. Slaptažodžio įvesties laukas Slaptažodžio laukas su rodymo jungikliu. Telefono įvesties laukas Telefono numerio laukas su šalies pasirinkimu ir formatavimu. Iššokantis langas Raiškusis turinys, pririštas prie aktyvinimo elemento ir užveriamas spustelėjus už jo ribų. Peržiūros kortelė Užvedus pelės žymeklį rodoma kortelė, peržiūrinti, į ką nukreipia nuoroda. Eiga Parodo, kiek užduotis jau atlikta. Radijo mygtukų grupė Parinkčių rinkinys, kuriame galima pasirinkti tik vieną. Įvertinimas Žvaigždučių valdiklis įvertinimui pažymėti. Slinkimo sritis Slenkamas konteineris su stilizuotomis, turinį uždengiančiomis slinkties juostomis. Pasirinkite Išskleidžiamasis sąrašas parinkčiai pasirinkti. Skirtukas Linija, atskirianti turinį arba valdiklių grupes. Skeletas Vietaženklio forma, rodoma kol įkeliamas turinys. Slankiklis Leidžia vilkti slankiklį ir pasirinkti reikšmę arba intervalą. Tarpas Fiksuotas vertikalaus ritmo žingsnis iš tarpų skalės. Suktukas Nurodo vykstantį darbą, kai jo trukmė nežinoma. Krūva Išdėsto antrinius elementus eilutėje arba stulpelyje su vienodais tarpais. Perjungiklis Perjungia iškart pritaikomą nustatymą. Lentelė Lentelės pavidalo duomenys su pasirenkamu rūšiavimu ir kintamomis eilučių spalvomis. Skirtukai Perjungia vienoje erdvėje esančius skydelius. Text Atvaizduoja tekstą pasirinktu dydžiu ir semantine žyma. Teksto sritis Kelių eilučių teksto laukas, didėjantis pagal eilučių skaičių. Laiko parinkiklis Leidžia pasirinkti paros laiką nustatytu žingsniu. Pranešimų tiekėjas Rodo trumpalaikius pranešimus ekrano kampe. Perjungiklis Mygtukas, kuris lieka paspaustas ir reiškia įjungtą būseną. Perjungimo grupė Perjungiklių rinkinys, skirtas vienam arba keliems pasirinkimams. Įrankių juosta Valdiklių eilutė, kurioje fokusas perkeliamas tarp valdiklių. Paaiškinimas Trumpas patarimas, rodomas užvedus pelės žymeklį ar perkėlus fokusą.