Preskočiť na obsah

Komponenty

Blockstudio dodáva 59 UI komponentov pri každom zostavení. Registrujú sa automaticky, štýlujú sa pomocou dizajnových tokenov a zapisujú sa rovnakou syntaxou značiek ako každý iný blok.

Blockstudio 7.3 obsahuje súbor bezhlavých blokov UI, ktoré využívajú WordPress Interactivity API. Sú zaregistrované v mennom priestore bsui/* a možno ich skladať v šablónach, stránkach založených na súboroch, vzoroch a obsahu príspevkov.

Poznámka

Komponenty UI sú v beta verzii, kým zhromažďujeme spätnú väzbu k súboru komponentov, názvom, správaniu a vzorom používania v projektoch. V 7.3 ich môžete vyskúšať, no rozhranie API sa môže ešte upraviť, kým ho označíme za stabilné.

Povolenie komponentov UI

Dodávané komponenty UI sú voliteľné. Povoľte ich vo svojej téme blockstudio.json:

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

Alebo ich povoľte pomocou filtra:

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

Po povolení Blockstudio zaregistruje dodávanú knižnicu komponentov z includes/ui/blocks.

Verejný zoznam a príklady

Bloky dodávanej implementácie zostávajú bežnými registráciami bsui/*, ale pri vytváraní galérie komponentov by spotrebitelia mali používať verejný zoznam rodín komponentov:

PHP
use Blockstudio\Ui;

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

Ui::inventory() zoskupuje každý zložený komponent pod jeho verejným koreňom a uvádza registrácie implementácie, ktoré daná rodina vyžaduje. Ui::examples() pridáva deterministickú normalizovanú deklaráciu s predvolenými a ilustračnými údajmi. Zachováva povinné vzťahy medzi koreňom a potomkami, takže výsledok možno priamo odovzdať do Blockstudio\Render::document().

Verejný zoznam Canvas sprístupňuje tieto príklady pod typom ui a vynecháva registrácie dodávaných implementácií z bežného typu blocks. Vďaka tomu vzniká jeden úplný príklad pre každú verejnú rodinu komponentov namiesto galérie interných fragmentov koreňov, spúšťačov, vyskakovacích okien a vrstiev.

Pri skladaní už vykresleného dokumentu Ui::global_assets($block_names, $html) vráti presný dodávaný globálny štýl a skript iba vtedy, keď vybraný výstup skutočne používa komponent UI.

Vykresľovanie

Použite bežnú syntax značiek blokov:

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

Funguje aj kratšia syntax <bs:>:

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

V šablónach Blockstudio sa značky blokov vykresľujú automaticky. Na stránkach založených na súboroch a vo vzoroch sa synchronizujú ako natívne bloky WordPress. Ak chcete vykresliť komponenty UI priamo z obsahu príspevku alebo oblastí miniaplikácií, povoľte značky blokov na úrovni stránky:

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

Základné komponenty

Jednoduché komponenty sa vykresľujú ako jeden 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>

Atribúty sa priamo mapujú na atribúty komponentu block.json. Napríklad bsui/button podporuje label, icon, iconPosition, href, variant, size a disabled.

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

Zložené komponenty

Mnohé komponenty UI pozostávajú z viacerých blokov. Koreňový blok spravuje stav a podradené bloky deklarujú svoj nadradený blok.

Karty

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>

Dialóg

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>

Výberové pole

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>

Polia formulára

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>

Dostupné bloky

Dodávaná knižnica UI obsahuje:

Oblasť Bloky
Rozloženie bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table
Akcie bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar
Vstupy 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
Prekrytia bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip
Navigácia bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs
Spätná väzba bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast
Formuláre bsui/field, bsui/field-group, bsui/form

Zložené komponenty sprístupňujú aj podradené bloky, napríklad bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup a bsui/select-option.

Štýlovanie

Komponenty UI sa dodávajú s vlastnými vlastnosťami CSS s predponou --bs-ui-*. Môžete ich prepísať vo svojej téme CSS:

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

Komponenty sa správajú bez vopred určeného vzhľadu, no ich pravidlá umožňujú používať ich hneď po inštalácii. Najprv prepíšte tokeny a podľa potreby pridajte špecifické CSS pre komponenty.

Štýly dodávaných komponentov CSS sa vkladajú do pomenovanej vrstvy kaskády bsui. Štýly CSS témy mimo vrstiev môžu prepísať pravidlá komponentov bez !important:

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

Ak chcete pridať vlastný variant bsui/button, pripojte možnosť výberu pomocou existujúceho filtra atribútov a zadajte variant CSS pomocou 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;
}';
});

Všetky komponenty

Rozbaľovacie sekcie Zoskupené sekcie, ktoré rozbalia vždy jeden panel. Výstražné dialógové okno Modálne okno, ktoré preruší prácu a pred zatvorením vyžaduje odpoveď. Pomer strán Zachováva pevný pomer šírky a výšky obsahu. Avatar Obrázok používateľa, pri ktorom sa pri zlyhaní načítania zobrazia iniciály. Odznak Malý štítok pre stavy, počty a kategórie. Navigačná omrvinka Zobrazuje polohu aktuálnej stránky v hierarchii. Tlačidlo Spúšťa akciu a ponúka varianty pre každú úroveň dôrazu. Skupina tlačidiel Spája súvisiace tlačidlá do jedného segmentovaného ovládacieho prvku. Kalendár Kalendárna mriežka na výber jedného dňa. Karta Plocha, ktorá zoskupuje hlavičku, telo a pätu. Karusel Posúvateľná dráha snímok s podporou klávesnice. Začiarkavacie políčko Binárna voľba, ktorá podporuje aj neurčitý stav. Zbaliteľný Skrýva a zobrazuje jednu oblasť obsahu. Výber farby Vyberie farbu a odošle ju spolu s okolitým formulárom. Kombinovaný zoznam Textové pole, ktoré počas písania filtruje zoznam možností. Kontextová ponuka Akcie zobrazené po kliknutí pravým tlačidlom myši a ukotvené pri kurzore. Vstupné pole dátumu Pole s maskou na zadávanie dátumov bez výberového okna. Dialógové okno Modálna vrstva na sústredené úlohy a potvrdenia. Bočný panel Panel, ktorý sa vysúva z ľubovoľného okraja obrazovky. Pole Obalí jeden ovládací prvok jeho označením, popisom a chybovou správou. Skupina polí Zoskupuje súvisiace polia pod spoločným názvom. Nahrávanie súboru Zóna na presúvanie súborov a výber súborov s podporou viacerých súborov. Formulár Odošle svoje polia a oznámi úspech bez opätovného načítania stránky. Vstup Jednoriadkové textové pole pre všetky bežné typy vstupu. Klávesová skratka Zobrazuje klávesovú skratku v samostatnom políčku klávesu. Označenie Popis ovládacieho prvku spoločný pre každý označený komponent. Ponuka Rozbaľovací zoznam akcií ukotvený pri spúšťači. Panel ponúk Vodorovný panel ponúk ako v desktopovej aplikácii. Merač Zobrazuje hodnotu v známom rozsahu. Navigačná ponuka Navigácia webu s vnorenými odkazmi a panelmi po prejdení kurzorom. Číselné pole Číselné pole s krokovacími tlačidlami a obmedzeným rozsahom. Vstupné pole OTP Oddelené políčka na zadanie jednorazového prístupového kódu. Stránkovanie Odkazy na stránky s predchádzajúcou, nasledujúcou a skrátenou stránkou. Vstupné pole hesla Pole hesla s prepínačom na jeho zobrazenie. Vstupné pole telefónneho čísla Telefónne pole s výberom krajiny a formátovaním. Vyskakovacie okno Bohatý obsah ukotvený k spúšťaču, ktorý sa zatvorí kliknutím mimo neho. Karta s ukážkou Karta pri umiestnení kurzora zobrazujúca náhľad cieľa odkazu. Priebeh Zobrazuje priebeh úlohy. Skupina prepínačov Súbor možností, z ktorých možno vybrať presne jednu. Hodnotenie Ovládací prvok s hviezdičkami na zaznamenanie hodnotenia. Oblasť posúvania Kontajner na posúvanie so štylizovanými posuvníkmi prekrytými nad obsahom. Vyberte Rozbaľovacie menu na výber z ponuky možností. Oddeľovač Čiara oddeľujúca obsah alebo skupiny ovládacích prvkov. Kostra Zástupný tvar, ktorý sa zobrazuje počas načítavania obsahu. Posuvník Vyberá hodnotu alebo rozsah ťahaním po dráhe. Medzera Pevný krok vertikálneho rytmu zo stupnice medzier. Krútiaci sa indikátor Signalizuje prebiehajúcu prácu bez známeho trvania. Zásobník Ukladá vnorené prvky do riadka alebo stĺpca s rovnomernými medzerami. Prepínač Prepína nastavenie, ktoré sa uplatní okamžite. Tabuľka Tabuľkové údaje s voliteľným radením a pruhovaním riadkov. Karty Prepína medzi panelmi, ktoré zaberajú rovnaký priestor. Text Zobrazuje text v zvolenej veľkosti a sémantickom značkovacom prvku. Textové pole Viacriadkové textové pole, ktoré sa zväčšuje podľa počtu riadkov. Výber času Vyberá čas dňa s nastaveným krokom. Poskytovateľ oznámení Zobrazuje dočasné upozornenia v rohu obrazovky. Prepínač Tlačidlo, ktoré zostáva stlačené a označuje zapnutý stav. Skupina prepínačov Súbor prepínačov fungujúcich ako výber jednej alebo viacerých možností. Panel nástrojov Riadok ovládacích prvkov s presúvaním fokusu medzi nimi. Tip Krátky tip zobrazený pri umiestnení kurzora alebo pri zameraní.