Liigu sisu juurde

Komponendid

Blockstudio sisaldab iga järguga kaasas 59 UI komponenti. Need registreeritakse automaatselt, kujundatakse disainitokenitega ja kirjutatakse sama sildisüntaksiga nagu kõik muud plokid.

Blockstudio 7.3 sisaldab komplektis peata UI plokke, mida käitab WordPress Interactivity API. Need registreeritakse nimeruumis bsui/* ning neid saab kasutada mallides, failipõhistel lehtedel, mustrites ja postituste sisus.

Märkus

UI komponendid on beetaversioonis, kuni kogume tagasisidet komponentide komplekti, nimede, käitumise ja projekti kasutusmustrite kohta. Neid saab 7.3-s proovida, kuid API liidest võidakse veel täiustada, enne kui see stabiilseks kuulutatakse.

Luba UI komponendid

Komplektis olevad UI komponendid on valikulised. Luba need oma teema failis blockstudio.json:

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

Või luba need filtriga:

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

Lubamisel registreerib Blockstudio komplektis oleva komponenditeegi aadressilt includes/ui/blocks.

Avalik loend ja näited

Komplektis olevad teostusplokid jäävad tavalisteks bsui/* registreeringuteks, kuid komponendigalerii koostamisel peaksid kasutajad lähtuma avalikust komponentide loendist:

PHP
use Blockstudio\Ui;

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

Ui::inventory() rühmitab kõik liitkomponendid avaliku juure alla ja loetleb selle pere jaoks vajalikud teostusregistreeringud. Ui::examples() lisab deterministliku normaliseeritud deklaratsiooni vaikeväärtuste ja näitlike andmetega. See säilitab nõutavad juure ja laste suhted, nii et tulemuse saab otse edasi anda funktsioonile Blockstudio\Render::document().

Avalik lõuendi loend pakub neid näiteid tüübi ui all ja jätab komplektis olevad teostusregistreeringud tavalisest tüübist blocks välja. Nii saadakse üks terviklik näide iga avaliku komponendipere kohta, mitte galerii sisemistest juure-, käivitaja-, hüpikakna- ja kihifragmenditest.

Juba renderdatud dokumendi kokkupanemisel tagastab Ui::global_assets($block_names, $html) komplektis oleva täpse globaalse stiili ja skripti ainult siis, kui valitud väljund kasutab tegelikult komponenti UI.

Renderdamine

Kasuta tavalist plokisildi süntaksit:

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

Sobib ka lühem süntaks <bs:>:

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

Mallides Blockstudio renderdatakse plokisildid automaatselt. Failipõhistel lehtedel ja mustrites sünkroonitakse need süsteemsete WordPress plokkidena. Kui soovid renderdada UI komponente otse postituse sisust või vidinaaladelt, luba lehepõhised plokisildid:

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

Põhikomponendid

Lihtsad komponendid renderdatakse ühe plokina:

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>

Atribuudid vastavad otse iga komponendi atribuutidele block.json. Näiteks toetab bsui/button järgmisi atribuute: label, icon, iconPosition, href, variant, size ja disabled.

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

Liitkomponendid

Paljud UI komponendid koosnevad mitmest plokist. Juureplokk haldab olekut ja alamplokid määravad oma vanema.

Vahelehed

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>

Dialoog

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>

Valikuloend

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>

Vormi väljad

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>

Saadaolevad plokid

Komplektis olev UI teek sisaldab:

Ala Plokid
Paigutus bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table
Toimingud bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar
Sisendid 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
Ülekattekihid bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip
Navigeerimine bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs
Tagasiside bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast
Vormid bsui/field, bsui/field-group, bsui/form

Liitkomponendid pakuvad ka alamplokke, näiteks bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup ja bsui/select-option.

Stiilimine

UI komponentidel on oma CSS kohandatud atribuudid prefiksiga --bs-ui-*. Saate need oma teema CSS-is üle kirjutada:

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

Komponentidel puudub kindel välimus, kuid nende käitumine on piisavalt läbimõeldud, et need kohe kasutusele võtta. Kirjuta esmalt token'id üle ja lisa vajaduse korral komponendipõhine CSS.

Komplektis oleva komponendi CSS väljastatakse nimetatud kaskaadikihis bsui. Teema kihistamata CSS saab komponendi reeglid üle kirjutada ilma !important-ta:

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

Kohandatud variandi bsui/button lisamiseks lisa valik olemasoleva atribuudifiltriga ja määra variandi CSS väärtuseks 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;
}';
});

Kõik komponendid

Akordion Üksteise järel avanevad sektsioonid, kus korraga laieneb üks paneel. Hoiatusdialoog Modaaldialoog katkestab tegevuse ja nõuab vastust enne sulgumist. Külgede suhe Piirab sisu kindla laiuse ja kõrguse suhtega. avatar Kasutaja pilt, mille laadimise ebaõnnestumisel kuvatakse initsiaalid. Märgis Väike silt oleku, arvu või kategooria tähistamiseks. Leivapuru rada Näitab praeguse lehe asukohta hierarhias. nupp Käivitab toimingu ja pakub rõhuasetuse eri tasemetele vastavaid variante. Nupurühm Ühendab seotud nupud üheks segmentjuhtnupuks. Kalender Kuupäevavõrgustik ühe päeva valimiseks. Kaart Pind, mis koondab päise, sisu ja jaluse. Karussell Pühkimisega juhitav slaidide riba klaviatuuritoega. Märkeruut Binaarne valik, mis toetab ka määramatut olekut. Kokkuklapitav Peidab ja kuvab ühe sisupiirkonna. Värvivalija Valib värvi ja saadab selle koos ümbritseva vormiga. Kombokast Tekstisisestusväli, mis filtreerib tippimise ajal valikute loendit. Kontekstimenüü Paremklõpsuga avatavad toimingud, mis on seotud kursori asukohaga. Kuupäeva sisestusväli Maskiga väli kuupäeva sisestamiseks ilma valijata. Dialoog Modaalkiht keskendumist nõudvate toimingute ja kinnituste jaoks. Sahtel Paneel, mis libiseb sisse ekraani mis tahes servast. Väli Ümbritseb üht juhtnuppu sildi, kirjelduse ja veateatega. Väljarühm Koondab seotud väljad ühise pealkirja alla. Faili üleslaadimine Failide lohistamisala ja failivalija mitme faili toega. Vorm Saadab väljade väärtused ja teatab õnnestumisest lehte uuesti laadimata. Sisend Üherealine tekstiväli kõigi levinud sisestustüüpide jaoks. Kiirklahv Kuvab klaviatuuri otsetee eraldi klahvikorgil. Silt Juhtnupu pealdis, mida jagavad kõik sildiga komponendid. Menüü Rippmenüü toimingute loendiga, mis avaneb käivitaja juures. Menüüriba Horisontaalne menüüriba nagu töölauarakenduses. Mõõdik Kuvab mõõdetud väärtuse teadaolevas vahemikus. Navigeerimismenüü Saidi navigeerimine pesastatud linkide ja hõljutamisel avanevate paneelidega. Numbriväli Numbriline sisestusväli sammimisnuppude ja piiratud vahemikuga. Ühekordse parooli sisestus Eraldi kastid ühekordse pääsukoodi sisestamiseks. Lehekülgede nummerdus Lehe lingid eelmisele ja järgmisele lehele koos kärpimisega. Parooli sisestus Parooliväli kuvamise lülitiga. Telefoninumbri sisestus Telefoniväli riigi valimise ja vormindusega. Hüpikmenüü Rikkaliku sisuga paneel, mis avaneb käivitaja juures ja sulgub välisklõpsul. Eelvaatekaart Hõljutamisel kuvatav kaart, mis eelvaatleb lingi sihtkohta. Edenemine Näitab ülesande edenemist. Raadionuppude rühm Valikute komplekt, millest saab valida täpselt ühe. Hinnang Tärnidega juhtnupp hinnangu andmiseks. Kerimisala Kerimiskonteiner kujundatud pealekerimisribadega. Valige Rippmenüü loendist valimiseks. Eraldaja Joon, mis eraldab sisu või juhtnuppude rühmi. Skeletivaade Kohatäite kujund, mis kuvatakse sisu laadimise ajal. Liugur Valib väärtuse või vahemiku, lohistades mööda rada. Tühik Vahemaa skaalast tulenev kindel vertikaalse rütmi samm. Pöörik Näitab käimasolevat tööd, mille kestus pole teada. Virn Paigutab alamüksused ühtlaste vahedega ritta või veergu. Lüliti Lülitab sätte sisse või välja ja rakendab muudatuse kohe. Tabel Tabelandmed valikulise sortimise ja triibutusega. Vahekaardid Vahetab samas ruumis paiknevate paneelide vahel. Text Kuvab proosateksti valitud suuruse ja semantilise märgendiga. Tekstiala Mitmerealine tekstiväli, mis kasvab ridade lisandudes. Kellaaja valija Valib kellaaja valitud sammuga. Teavituste pakkuja Kuvab ajutised teavitused ekraani nurgas. Lüliti Nupp, mis jääb sisselülitatud olekut tähistades allavajutatuks. Lülitusrühm Lülitite komplekt, mis võimaldab valida ühe või mitu valikut. tööriistariba Juhtnuppude rida, mille vahel saab fookust liigutada. kohtspikker Lühike vihje, mis kuvatakse hõljutamisel või fookuse saamisel.