Preskoči na vsebino

Komponente

Blockstudio vključuje 59 UI komponent z vsako gradnjo. Registrirajo se samodejno, oblikujejo z oblikovnimi žetoni in ustvarijo z enako sintakso značk kot kateri koli drug blok.

Blockstudio 7.3 vključuje nabor brezglavih blokov UI, ki jih poganja WordPress Interactivity API. Registrirani so pod imenskim prostorom bsui/* in jih je mogoče sestavljati v predlogah, datotečnih straneh, vzorcih in vsebini objav.

Opomba

Komponente UI so v različici beta, medtem ko zbiramo povratne informacije o naboru komponent, poimenovanju, delovanju in vzorcih uporabe v projektih. Preizkusite jih lahko v različici 7.3, vendar se lahko površina API še izboljša, preden jo označimo kot stabilno.

Omogočite komponente UI

Priložene komponente UI so neobvezne. Omogočite jih v datoteki blockstudio.json svoje teme:

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

Lahko pa jih omogočite s filtrom:

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

Ko so omogočene, Blockstudio registrira priloženo knjižnico komponent iz includes/ui/blocks.

Javni seznam in primeri

Priloženi bloki za implementacijo ostanejo običajne registracije bsui/*, vendar naj uporabniki pri ustvarjanju galerije komponent uporabijo javni seznam družin:

PHP
use Blockstudio\Ui;

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

Ui::inventory() združi vsako sestavljeno komponento pod njenim javnim korenom in navede registracije implementacij, ki jih ta družina potrebuje. Ui::examples() doda deterministično normalizirano deklaracijo s privzetimi in ponazoritvenimi podatki. Ohrani zahtevana razmerja med koreni in podrejenimi elementi, zato lahko rezultat neposredno posredujete v Blockstudio\Render::document().

Javni seznam Canvas te primere izpostavlja pod svojim tipom ui in iz običajnega tipa blocks izpušča priložene registracije implementacij. Tako nastane po en celovit primer za vsako javno družino komponent, namesto galerije notranjih fragmentov korenov, sprožilcev, pojavnih oken in plasti.

Pri sestavljanju že izrisanega dokumenta Ui::global_assets($block_names, $html) vrne točno določena priložena globalna sloga in skript samo, če izbrani izhod dejansko uporablja komponento UI.

Izrisovanje

Uporabite običajno sintakso oznak blokov:

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

Deluje tudi krajša sintaksa <bs:>:

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

V predlogah Blockstudio se oznake blokov izrišejo samodejno. Na datotečnih straneh in v vzorcih se sinhronizirajo kot izvorni bloki WordPress. Če želite komponente UI izrisati neposredno iz vsebine objav ali območij gradnikov, omogočite oznake blokov na ravni strani:

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

Osnovne komponente

Preproste komponente se izrišejo kot en sam blok:

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>

Atributi se neposredno preslikajo v atribute block.json posamezne komponente. Komponenta bsui/button na primer podpira label, icon, iconPosition, href, variant, size in disabled.

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

Sestavljene komponente

Številne komponente UI so sestavljeni bloki. Korenski blok upravlja stanje, podrejeni bloki pa določijo svoj nadrejeni blok.

Zavihki

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>

Dialog

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>

Izbirnik

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>

Polja obrazca

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>

Razpoložljivi bloki

Priložena knjižnica UI vključuje:

Območje Bloki
Postavitev bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table
Dejanja bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar
Vnosi 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
Prekrivni elementi bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip
Krmarjenje bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs
Povratne informacije bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast
Obrazci bsui/field, bsui/field-group, bsui/form

Sestavljene komponente izpostavljajo tudi podrejene bloke, kot so bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup in bsui/select-option.

Slogi

Komponente UI imajo lastne lastnosti po meri CSS s predpono --bs-ui-*. Preglasite jih lahko v CSS svoje teme:

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

Komponente so po vedenju brezglave, vendar dovolj usmerjene, da jih lahko uporabite takoj. Najprej preglasite žetone, nato po potrebi dodajte slogovna pravila CSS za posamezne komponente.

Slogi priloženih komponent CSS so izpisani v imenovani kaskadni plasti bsui. Slogi CSS teme brez plasti lahko preglasijo pravila komponent brez !important:

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

Če želite dodati različico po meri za bsui/button, dodajte možnost izbirnika s filtrom obstoječih atributov in določite CSS različice z 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;
}';
});

Vse komponente

Razširljivi seznam Zloženi razdelki, ki odprejo po eno ploščo. Opozorilno pogovorno okno Modalno okno, ki prekine potek in zahteva odgovor, preden se zapre. Razmerje stranic Vsebino omeji na določeno razmerje med širino in višino. Avatar Uporabniška slika, ki se ob napaki pri nalaganju nadomesti z začetnicami. Značka Kratka oznaka stanja, števila ali kategorije. Drobtinice Prikaže mesto trenutne strani v hierarhiji. Gumb Sproži dejanje in ponuja različice za vsako stopnjo poudarka. Skupina gumbov Poveže sorodne gumbe v en segmentiran kontrolnik. Koledar Koledarska mreža za izbiro posameznega dne. Kartica Površina, ki združuje glavo, telo in nogo. Vrtiljak Drsna sled diapozitivov s podporo za tipkovnico. Potrditveno polje Binarna izbira, ki podpira tudi nedoločeno stanje. Zložljivo Skrije ali prikaže eno območje vsebine. Izbirnik barv Izbere barvo in jo pošlje skupaj z okoliškim obrazcem. Kombinirani seznam Vnosno polje za besedilo, ki med tipkanjem filtrira seznam možnosti. Kontekstni meni Dejanja, prikazana ob desnem kliku in pripeta na kazalec. Vnos datuma Maskirano polje za vnos datumov brez izbirnika. Pogovorno okno Modalna plast za osredotočena opravila in potrditve. Drsni predal Plošča, ki zdrsne z roba zaslona. Polje En kontrolnik opremi z oznako, opisom in napako. Skupina polj Sorodna polja združi pod skupnim naslovom. Nalaganje datoteke Območje za spuščanje in izbirnik datotek s podporo za več datotek. Obrazec Pošlje polja in sporoči uspeh brez ponovnega nalaganja. Vhod Enovrstično besedilno polje za vse običajne vrste vnosa. Bližnjica na tipkovnici Bližnjico na tipkovnici prikaže v svoji tipki. Oznaka Napis za kontrolnik, ki ga delijo vse označene komponente. Meni Spustni seznam dejanj, pripet na sprožilec. Menijska vrstica Vodoravna menijska vrstica, kot v namizni aplikaciji. Merilnik Prikaže meritev znotraj znanega razpona. Navigacijski meni Krmarjenje po spletnem mestu z gnezdenimi povezavami in ploščami ob prehodu miške. Številsko polje Številski vnos s kontrolniki za spreminjanje vrednosti in omejenim razponom. Vnos OTP Ločena polja za vnos enkratne kode. Oštevilčenje strani Povezave do strani s prejšnjo in naslednjo stranjo ter skrajšanimi nizi. Vnos gesla Polje za geslo s preklopom za prikaz. Vnos telefonske številke Polje za telefonsko številko z izbiro države in oblikovanjem. Pojavno okno Obogatena vsebina, pripeta na sprožilec, ki se zapre ob kliku zunaj. Kartica predogleda Kartica ob prehodu miške, ki prikaže predogled cilja povezave. Napredek Prikaže napredek opravila. Skupina izbirnih gumbov Nabor možnosti, med katerimi je mogoče izbrati natanko eno. Ocena Zvezdice za ocenjevanje. Območje drsenja Drsni vsebnik s slogovno oblikovanimi prekrivnimi drsniki. Izberite Spustni seznam za izbiro možnosti. Ločilo Črta, ki ločuje vsebino ali skupine kontrolnikov. Okostje Nadomestna oblika, prikazana med nalaganjem vsebine. Drsnik Z vlečenjem vzdolž sledi izbere vrednost ali razpon. Presledek Fiksni korak navpičnega ritma iz lestvice razmikov. Vrteči se kazalnik Označuje delo v teku brez znanega trajanja. Sklad Podrejene elemente razporedi v vrstico ali stolpec z enakomernimi razmiki. Preklopno stikalo Preklopi nastavitev, ki se uveljavi takoj. Tabela Tabelarični podatki z možnostjo razvrščanja in izmeničnega senčenja vrstic. Zavihki Preklaplja med ploščami, ki zasedajo isti prostor. Text Izriše besedilo v izbrani velikosti in semantični oznaki. Besedilno območje Večvrstično besedilno polje, ki se širi glede na število vrstic. Izbirnik časa Izbere čas dneva v določenih korakih. Ponudnik obvestil Prikazuje začasna obvestila v kotu zaslona. Preklop Gumb, ki ostane pritisnjen in predstavlja vklopljeno stanje. Skupina preklopnikov Nabor preklopnih možnosti za izbiro ene ali več vrednosti. Orodna vrstica Vrstica kontrolnikov s premikajočim se fokusom med njimi. Namig Kratko pojasnilo, prikazano ob prehodu miške ali fokusu.