Ugrás a tartalomhoz

Komponensek

Blockstudio minden builddel 59 UI komponenst szállít. Automatikusan regisztrálódnak, tervezési tokenekkel vannak stílusozva, és ugyanazzal a címkeszintaxissal készülnek, mint bármely más blokk.

A Blockstudio 7.3 a WordPress Interactivity API által működtetett, fej nélküli UI blokkok beépített készletét tartalmazza. Ezeket a bsui/* névtérben regisztrálja, és sablonokban, fájlalapú oldalakon, mintákban és bejegyzéstartalomban lehet őket kombinálni.

Megjegyzés

A UI komponensek bétaverzióban vannak, amíg visszajelzéseket gyűjtünk a komponenskészletről, az elnevezésről, a működésről és a projektben alkalmazott mintákról. A 7.3-as verzióban már kipróbálhatók, de a API felülete még változhat, mielőtt stabilnak minősül.

UI komponensek engedélyezése

A beépített UI komponensek használata külön engedélyezést igényel. Engedélyezd őket a témád blockstudio.json fájljában:

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

Vagy engedélyezd őket egy szűrővel:

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

Engedélyezéskor a Blockstudio regisztrálja a includes/ui/blocks beépített komponenskönyvtárát.

Nyilvános leltár és példák

A beépített megvalósítási blokkok továbbra is szokásos bsui/*-regisztrációk, komponensgaléria létrehozásakor azonban a felhasználóknak a nyilvános családleltárt kell használniuk:

PHP
use Blockstudio\Ui;

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

A Ui::inventory() minden összetett komponenst a nyilvános gyökéreleme alá sorol, és felsorolja a családhoz szükséges megvalósítási regisztrációkat. A Ui::examples() egy determinisztikus, normalizált deklarációt ad alapértelmezett és szemléltető adatokkal. Megőrzi a kötelező gyökér- és gyermekkapcsolatokat, így az eredmény közvetlenül átadható a Blockstudio\Render::document() számára.

A nyilvános Canvas-leltár ezeket a példákat a ui típus alatt teszi elérhetővé, és kihagyja a beépített megvalósítási regisztrációkat a szokásos blocks típusból. Így minden nyilvános komponenscsaládhoz egy teljes példa készül, nem pedig belső gyökér-, megnyitó-, felugróablak- és rétegtöredékekből álló galéria.

Egy már megjelenített dokumentum összeállításakor a Ui::global_assets($block_names, $html) csak akkor adja vissza a pontos beépített globális stílust és szkriptet, ha a kiválasztott kimenet valóban használ egy UI komponenst.

Renderelés

Használd a szokásos blokkcímke-szintaxist:

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

A rövidebb <bs:> szintaxis is működik:

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

A Blockstudio sablonjaiban a blokkcímkék automatikusan megjelennek. A fájlalapú oldalakon és mintákban natív WordPress blokkokként szinkronizálódnak. Ha közvetlenül a bejegyzéstartalomból vagy a widgetterületekről szeretnéd megjeleníteni a UI komponenseket, engedélyezd az oldalszintű blokkcímkéket:

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

Alapkomponensek

Az egyszerű komponensek egyetlen blokként jelennek meg:

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>

Az attribútumok közvetlenül az egyes komponensek block.json attribútumaihoz rendelődnek. Például a bsui/button a következőket támogatja: label, icon, iconPosition, href, variant, size és disabled.

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

Összetett komponensek

Sok UI komponens összetett blokkokból áll. A gyökérblokk kezeli az állapotot, a gyermekblokkok pedig deklarálják a szülőjüket.

Lapfülek

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>

Párbeszédablak

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>

Kiválasztó

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>

Űrlapmezők

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>

Elérhető blokkok

A beépített UI könyvtár a következőket tartalmazza:

Terület Blokkok
Elrendezés bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table
Műveletek bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar
Bemenetek 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
Rétegek bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip
Navigáció bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs
Visszajelzés bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast
Űrlapok bsui/field, bsui/field-group, bsui/form

Az összetett komponensekhez további gyermekblokkok is tartoznak, például bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup és bsui/select-option.

Stílusozás

A UI komponensek saját, --bs-ui-* előtagot használó CSS egyéni tulajdonságokkal rendelkeznek. Ezeket felülírhatod a témád CSS fájljában:

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

A komponensek működésük szerint fej nélküliek, de elég határozott alapértelmezésekkel rendelkeznek ahhoz, hogy azonnal használhatók legyenek. Először írd felül a jelölőket, majd szükség szerint adj hozzájuk egyedi CSS szabályokat.

A beépített komponens CSS a megadott bsui kaszkádrétegbe kerül. A réteg nélküli téma-CSS felülírhatja a komponens szabályait !important nélkül:

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

Egyéni bsui/button változat hozzáadásához fűzd hozzá a kiválasztási lehetőséget a meglévő attribútumszűrővel, és add meg a változat CSS értékét a blockstudio/ui/button/variants-style segítségével:

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;
}';
});

Összes komponens

Lenyitható panel Egymásra rétegzett szakaszok, amelyek egyszerre egy panelt nyitnak ki. Riasztási párbeszédablak Egy modális ablak, amely megszakítja a folyamatot, és válaszra vár a bezárás előtt. Képarány Rögzített szélesség-magasság arányhoz igazítja a tartalmat. Avatar Felhasználói kép, amely betöltési hiba esetén a monogramot jeleníti meg. Jelvény Kis címke az állapot, a darabszám és a kategóriák jelzésére. Morzsamenü Megmutatja, hol helyezkedik el az aktuális oldal a hierarchiában. Gomb Műveletet indít, a kiemelés minden szintjéhez külön változattal. Gombcsoport A kapcsolódó gombokat egyetlen szegmentált vezérlővé fogja össze. Naptár Dátumrács egyetlen nap kiválasztásához. Kártya Fejlécet, törzset és láblécet csoportosító felület. Lapozható galéria Lapozható diavetítés billentyűzet-támogatással. Jelölőnégyzet Kétállapotú választó, amely a nem meghatározott állapotot is támogatja. Összecsukható Elrejt és megjelenít egy tartalmi részt. Színválasztó Színt választ, majd elküldi a környező űrlappal. Kombinált mező Szövegmező, amely gépelés közben szűri a lehetőségek listáját. Helyi menü Jobb kattintásra megjelenő műveletek, a mutatóhoz rögzítve. Dátummező Maszkolt mező dátum beírásához dátumválasztó nélkül. Párbeszédablak Modális réteg fókuszált feladatokhoz és megerősítésekhez. Oldalsó panel A képernyő bármely széléről becsúszó panel. Mező Egy vezérlőt a címkéjével, leírásával és hibaüzenetével együtt jelenít meg. Mezőcsoport Kapcsolódó mezőket csoportosít közös cím alatt. Fájlfeltöltés Fájlledobási terület és fájlválasztó több fájl támogatásával. Űrlap Elküldi a mezők tartalmát, és újratöltés nélkül jelzi a sikert. Bemenet Egysoros szövegmező a leggyakoribb bemenettípusokhoz. Billentyűparancs Saját billentyűsapkáján jeleníti meg a billentyűparancsot. Címke Vezérlőfelirat, amelyet minden feliratozott komponens megoszt. Menü Műveletek legördülő listája, amely egy kiváltó elemhez van rögzítve. Menüsor Vízszintes menüsáv, mint egy asztali alkalmazásban. Mérő Egy ismert tartományon belül jeleníti meg a mért értéket. Navigációs menü Webhely-navigáció beágyazott hivatkozásokkal és rámutatásra nyíló panelekkel. Számmező Léptetőgombokkal ellátott számmező korlátozott tartománnyal. Egyszer használatos jelszó mező Különálló mezők egyszer használatos jelkód beírásához. Lapozás Oldalhivatkozások előző és következő elemmel, valamint rövidítéssel. Jelszómező Jelszómező megjelenítési kapcsolóval. Telefonszámmező Telefonszámmező országválasztással és formázással. Felugró panel Gazdag tartalom egy kiváltó elemhez rögzítve, külső kattintásra bezárva. Előnézeti kártya Rámutatáskor megjelenő kártya, amely előnézetet ad a hivatkozás céljáról. Folyamat Megmutatja, milyen előrehaladott egy feladat. Választógombcsoport Lehetőségek csoportja, amelyből pontosan egy választható ki. Értékelés Csillagvezérlő pontszám megadásához. Görgethető terület Görgethető tároló stílusozott, átfedő görgetősávokkal. Válassza ki a címet. Legördülő lista választáshoz. Elválasztó Tartalmat vagy vezérlőcsoportokat elválasztó vonal. Vázlat Helyőrző alakzat, amely a tartalom betöltéséig jelenik meg. Csúszka Értéket vagy tartományt választhat a sávon való húzással. Térköz Rögzített függőleges térközlépés a térközskálából. Forgó ikon Folyamatban lévő munkát jelez, ismert időtartam nélkül. Halmozott A gyermekelemeket sorba vagy oszlopba rendezi egységes térközökkel. Kapcsoló Azonnal érvényesülő beállítást kapcsol át. Táblázat Táblázatos adatok opcionális rendezéssel és váltakozó sorszínezéssel. Lapfülek Az azonos területet elfoglaló panelek között vált. Text Prózai szöveget jelenít meg választott méretben és szemantikus címkével. Szövegterület Többsoros szövegmező, amely a sorok számával együtt nő. Időválasztó Napszakot választ megadott lépésközzel. Értesítésszolgáltató Átmeneti értesítéseket jelenít meg a képernyő egyik sarkában. Váltó Lenyomott állapotban maradó gomb, amely a bekapcsolt állapotot jelzi. Kapcsolócsoport Kapcsolók csoportja egy vagy több választási lehetőséggel. Eszköztár Vezérlők sora, amelyek között a fókusz léptethető. Buboréksúgó Rövid súgó, amely rámutatáskor vagy fókuszba kerüléskor jelenik meg.