Pāriet uz saturu

Komponenti

Blockstudio katrā būvējumā iekļauj 59 UI komponentus. Tie tiek reģistrēti automātiski, veidoti ar dizaina marķieriem un rakstīti, izmantojot to pašu tagu sintaksi kā jebkuram citam blokam.

Blockstudio 7.3 ietver komplektā iekļautu bezsaskarnes UI bloku kopu, ko darbina WordPress Interactivity API. Tie ir reģistrēti bsui/* nosaukumvietā, un tos var kombinēt veidnēs, failos balstītās lapās, paraugos un ziņu saturā.

Piezīme

UI komponenti ir beta versijā, kamēr apkopojam atsauksmes par komponentu kopu, nosaukumiem, darbību un lietošanas modeļiem projektos. Tos var izmēģināt versijā 7.3, taču API saskarne vēl var tikt pilnveidota, pirms tā tiks atzīta par stabilu.

Iespējojiet UI komponentus

Komplektā iekļautie UI komponenti pēc noklusējuma ir izslēgti. Iespējojiet tos motīva blockstudio.json:

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

Vai iespējojiet tos ar filtru:

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

Kad iespējots, Blockstudio reģistrē komplektā iekļauto komponentu bibliotēku no includes/ui/blocks.

Publiskais saraksts un piemēri

Komplektā iekļautie implementācijas bloki joprojām ir parastas bsui/* reģistrācijas, taču, veidojot komponentu galeriju, lietotājiem vajadzētu izmantot publisko saimju sarakstu:

PHP
use Blockstudio\Ui;

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

Ui::inventory() grupē katru salikto komponentu zem tā publiskā saknes elementa un uzskaita šai saimei vajadzīgās implementācijas reģistrācijas. Ui::examples() pievieno deterministisku, normalizētu deklarāciju ar noklusējuma un ilustratīvajiem datiem. Tā saglabā obligātās saknes un bērnelementu attiecības, tāpēc rezultātu var tieši nodot Blockstudio\Render::document().

Publiskais Canvas saraksts rāda šos piemērus ar tipu ui un izslēdz komplektā iekļautās implementācijas reģistrācijas no parastā tipa blocks. Tādējādi katrai publiskajai komponentu saimei ir viens pilnīgs piemērs, nevis galerija ar iekšējiem saknes elementu, aktivizētāju, uznirstošo logu un slāņu fragmentiem.

Sagatavojot jau attēlotu dokumentu, Ui::global_assets($block_names, $html) atgriež precīzu komplektā iekļauto globālo stilu un skriptu tikai tad, ja atlasītajā izvadē faktiski tiek izmantots komponents UI.

Renderēšana

Izmantojiet parasto bloka tagu sintaksi:

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

Darbojas arī īsākā sintakse <bs:>:

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

Veidnēs Blockstudio bloku tagi tiek attēloti automātiski. Failos balstītās lapās un paraugos tie tiek sinhronizēti kā vietējie WordPress bloki. Ja vēlaties attēlot UI komponentus tieši no ziņu satura vai logrīku apgabaliem, iespējojiet lapas līmeņa bloku tagus:

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

Pamata komponenti

Vienkārši komponenti tiek attēloti kā viens bloks:

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>

Atribūti tiek tieši sasaistīti ar katra komponenta block.json atribūtiem. Piemēram, bsui/button atbalsta label, icon, iconPosition, href, variant, size un disabled.

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

Saliktie komponenti

Daudzi UI komponenti ir salikti bloki. Saknes bloks pārvalda stāvokli, bet bērnu bloki norāda savu vecāku.

Cilnes

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>

Dialoglodziņš

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>

Atlase

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>

Veidlapas lauki

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>

Pieejamie bloki

Komplektā iekļautajā UI bibliotēkā ir:

Joma Bloki
Izkārtojums bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table
Darbības bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar
Ievade 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
Pārklājumi bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip
Navigācija bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs
Atsauksmes bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast
Veidlapas bsui/field, bsui/field-group, bsui/form

Saliktajiem komponentiem ir arī tādi bērnu bloki kā bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup un bsui/select-option.

Stili

UI komponenti ir aprīkoti ar saviem CSS pielāgotajiem rekvizītiem, kuru prefikss ir --bs-ui-*. Tos varat pārrakstīt motīva CSS:

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

Komponentu darbība ir bezsaskarnes, tomēr to uzskati ļauj tos uzreiz lietot. Vispirms pārrakstiet tokenus, pēc tam pievienojiet komponentam specifisku CSS, ja nepieciešams.

Komplektā iekļautie komponentu CSS tiek izvadīti nosauktajā kaskādes slānī bsui. Motīva CSS, kas nav slāņots, var pārrakstīt komponentu kārtulas bez !important:

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

Lai pievienotu pielāgotu bsui/button variantu, pievienojiet atlases opciju ar esošo atribūtu filtru un norādiet varianta CSS, izmantojot 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 komponenti

Akordeons Viena pēc otras izkārtotas sadaļas, kas vienlaikus atver pa vienam panelim. Brīdinājuma dialogs Modālais logs pārtrauc darbplūsmu un pieprasa atbildi, pirms to var aizvērt. Malu attiecība Fiksē satura platuma un augstuma attiecību. Avatārs Lietotāja attēls, kurā ielādes kļūmes gadījumā tiek rādīti iniciāļi. Nozīmīte Neliela etiķete statusam, skaitiem un kategorijām. Atpakaļceļa norādes Parāda pašreizējās lapas atrašanās vietu hierarhijā. Poga Izpilda darbību ar variantiem dažādiem uzsvara līmeņiem. Pogu grupa Apvieno saistītās pogas vienā segmentētā vadīklā. Kalendārs Datumu režģis vienas dienas izvēlei. Kartīte Virsma, kurā apvienota galvene, pamatdaļa un kājene. Karuselis Pārbīdāma slaidu josla ar tastatūras atbalstu. Atzīmēšanas rūtiņa Bināras izvēles vadīkla, kas atbalsta arī nenoteiktu stāvokli. Sakļaujams Paslēpj un parāda vienu satura apgabalu. Krāsu atlasītājs Izvēlas krāsu un iesniedz to kopā ar apkārtējo veidlapu. Kombinētais lodziņš Teksta ievades lauks, kas rakstīšanas laikā filtrē opciju sarakstu. Konteksta izvēlne Darbības, kas atveras, noklikšķinot ar labo peles pogu, un tiek novietotas pie rādītāja. Datuma ievade Maskēts lauks datumu ievadīšanai bez datuma atlasītāja. Dialogs Modāls slānis fokusētiem uzdevumiem un apstiprinājumiem. Atvilktne Panelis, kas ieslīd no jebkuras ekrāna malas. Lauks Apvieno vadīklu ar tās etiķeti, aprakstu un kļūdas paziņojumu. Lauku grupa Grupē saistītos laukus zem kopīga virsraksta. Faila augšupielāde Failu nomešanas zona un atlasītājs ar vairāku failu atbalstu. Veidlapa Iesniedz veidlapas laukus un parāda sekmīgu izpildi bez lapas pārlādes. Ievade Vienas rindas teksta lauks visiem ierastajiem ievades veidiem. Tastatūras saīsne Parāda tastatūras saīsni atsevišķā taustiņa ietvarā. Etiķete Vadīklas paraksts, ko izmanto visi komponenti ar etiķetēm. Izvēlne Darbību nolaižamais saraksts, kas piesaistīts aktivizētājam. Izvēļņu josla Horizontāla izvēļņu josla kā datora lietotnē. Mērītājs Parāda mērījumu zināmā diapazonā. Navigācijas izvēlne Vietnes navigācija ar ligzdotām saitēm un paneļiem, kas atveras, novietojot kursoru. Skaitļa lauks Skaitliskās ievades lauks ar pakāpeniskām vadīklām un ierobežotu diapazonu. Vienreizējās paroles ievade Atsevišķi lauciņi vienreizējas piekļuves koda ievadīšanai. Lapu numerācija Lapu saites ar iepriekšējo, nākamo un saīsinātu attēlojumu. Paroles ievade Paroles lauks ar parādīšanas slēdzi. Tālruņa ievade Tālruņa numura lauks ar valsts izvēli un formatēšanu. Uznirstošais logs Bagātināts saturs, kas piesaistīts aktivizētājam un tiek aizvērts, noklikšķinot ārpus tā. Priekšskatījuma kartīte Norādes kartīte, kas parāda saites galamērķa priekšskatījumu. Progress Parāda uzdevuma izpildes gaitu. Radio pogu grupa Opciju kopa, kurā var atlasīt tieši vienu opciju. Vērtējums Zvaigžņu vadīkla vērtējuma piešķiršanai. Ritināšanas apgabals Ritināms konteiners ar stilizētām pārklājošām ritjoslām. Atlasiet Nolaižamais saraksts opcijas izvēlei. Atdalītājs Līnija, kas atdala saturu vai vadīklu grupas. Skelets Viettura forma, kas tiek rādīta, kamēr ielādējas saturs. Slīdnis Izvēlas vērtību vai diapazonu, velkot pa sliedi. Atstarpe Fiksēts vertikālās ritmikas solis no atstarpju skalas. Griezulis Norāda uz notiekošu darbu, kura ilgums nav zināms. Kaudze Izvieto pakārtotos elementus rindā vai kolonnā ar vienādām atstarpēm. Slēdzis Pārslēdz iestatījumu, kas stājas spēkā nekavējoties. Tabula Tabulas dati ar neobligātu kārtošanu un rindu iekrāsošanu. Cilnes Pārslēdzas starp paneļiem, kas aizņem vienu un to pašu vietu. Text Attēlo tekstu izvēlētajā izmērā un semantiskajā tagā. Teksta apgabals Vairāku rindu teksta lauks, kas aug līdz ar rindu skaitu. Laika atlasītājs Izvēlas diennakts laiku ar noteiktu soli. Paziņojumu nodrošinātājs Ekrāna stūrī rāda īslaicīgus paziņojumus. Pārslēgs Poga, kas paliek nospiesta, lai attēlotu ieslēgtu stāvokli. Pārslēgšanas grupa Pārslēdzēju kopa, kas darbojas kā vienas vai vairāku izvēļu vadīkla. Rīkjosla Vadīklu rinda, kurā fokusu var pārvietot starp elementiem. Rīka padoms Īss padoms, kas tiek parādīts, novietojot kursoru vai iestatot fokusu.