Компоненти
Blockstudio постачається з 59 UI компонентами в кожній збірці. Вони реєструються автоматично, стилізуються за допомогою токенів дизайну та створюються з тим самим синтаксисом тегів, що й будь-який інший блок.
Blockstudio 7.3 містить вбудований набір безголових блоків UI на основі WordPress Інтерактивності API. Вони зареєстровані в просторі назв bsui/* і можуть компонуватися в шаблонах, сторінках на основі файлів, патернах і вмісті дописів.
Примітка
Компоненти UI перебувають у бета-версії, поки ми збираємо відгуки про набір компонентів, їхні назви, поведінку та способи використання в проєктах. Їх можна випробувати у версії 7.3, але інтерфейс API може змінитися, перш ніж його буде визнано стабільним.
Увімкнення компонентів UI
Вбудовані компоненти UI вимкнені за замовчуванням. Увімкніть їх у blockstudio.json своєї теми:
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"ui": {
"enabled": true
}
}
Або увімкніть їх за допомогою фільтра:
add_filter('blockstudio/settings/ui/enabled', '__return_true');
Після ввімкнення Blockstudio реєструє вбудовану бібліотеку компонентів із includes/ui/blocks.
Загальнодоступний перелік і приклади
Вбудовані блоки реалізації залишаються звичайними реєстраціями bsui/*, але
під час створення галереї компонентів користувачам слід використовувати публічний перелік родин компонентів:
use Blockstudio\Ui;
$families = Ui::inventory();
$examples = Ui::examples();
Ui::inventory() об’єднує всі складені компоненти під їхнім загальнодоступним коренем
і перелічує реєстрації реалізації, потрібні для цієї родини.
Ui::examples() додає детерміноване нормалізоване оголошення зі значеннями за замовчуванням та
ілюстративними даними. Воно зберігає обов’язкові зв’язки між коренем і дочірніми елементами,
тому результат можна безпосередньо передати до Blockstudio\Render::document().
Загальнодоступний перелік Canvas показує ці приклади в типі ui
і не включає вбудовані реєстрації реалізації до звичайного типу blocks. Завдяки цьому для кожної загальнодоступної родини компонентів створюється один повний приклад, а не галерея з внутрішніх фрагментів кореня, тригера, спливного вікна й шару.
Під час складання вже відтвореного документа Ui::global_assets($block_names, $html) повертає точний глобальний стиль і скрипт із вбудованого набору, лише якщо серед вибраного виводу справді використовується компонент UI.
Рендеринг
Використовуйте звичайний синтаксис тегів блока:
<block name="bsui/button" label="Save" variant="default"></block>
Коротший синтаксис <bs:> теж працює:
<bs:bsui-button label="Save" variant="default" />
У шаблонах Blockstudio теги блоків відтворюються автоматично. На сторінках і в патернах на основі файлів вони синхронізуються як нативні блоки WordPress. Щоб безпосередньо відтворювати компоненти UI з вмісту дописів або областей віджетів, увімкніть теги блоків на рівні сторінки:
{
"ui": {
"enabled": true
},
"blockTags": {
"enabled": true,
"allow": ["bsui/*", "app/*"]
}
}
Базові компоненти
Прості компоненти відтворюються як один блок:
<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>
Атрибути безпосередньо відповідають атрибутам block.json кожного компонента. Наприклад, bsui/button підтримує label, icon, iconPosition, href, variant, size і disabled.
bs_render_block([
'name' => 'bsui/button',
'data' => [
'label' => 'Continue',
'icon' => [
'set' => 'heroicons',
'subSet' => 'outline',
'icon' => 'arrow-right',
],
'iconPosition' => 'right',
],
]);
Складені компоненти
Багато компонентів UI складаються з кількох блоків. Кореневий блок керує станом, а дочірні блоки оголошують свого батьківського елемента.
Вкладки
<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>
Діалогове вікно
<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>
Список вибору
<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>
Поля форми
<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>
Доступні блоки
Вбудована бібліотека UI містить:
| Область | Блоки |
|---|---|
| Макет | bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table |
| Дії | bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar |
| Поля введення | 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 |
| Накладки | bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip |
| Навігація | bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs |
| Зворотний зв’язок | bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast |
| Форми | bsui/field, bsui/field-group, bsui/form |
Складені компоненти також мають дочірні блоки, як-от bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup і bsui/select-option.
Стилізація
Компоненти UI постачаються з власними користувацькими властивостями CSS із префіксом --bs-ui-*. Їх можна перевизначити у CSS своєї теми:
:root {
--bs-ui-radius: 0.5rem;
--bs-ui-primary: oklch(0.45 0.18 260);
--bs-ui-primary-foreground: white;
}
Компоненти не мають вбудованого оформлення поведінки, але достатньо визначені, щоб працювати одразу після встановлення. Спершу перевизначте токени, а потім за потреби додайте специфічні для компонента CSS.
Вбудований CSS компонентів виводиться в іменованому каскадному шарі bsui. CSS теми без шару може перевизначати правила компонентів без !important:
.button-brand {
background: var(--brand-primary);
}
Щоб додати власний варіант bsui/button, додайте опцію списку вибору за допомогою
наявного фільтра атрибутів і передайте варіанту CSS через
blockstudio/ui/button/variants-style:
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;
}';
});
Пов’язані матеріали
- UI Композиція, зокрема контрольовані поля, картки полів і роздільники панелі інструментів
- Програмний рендеринг
- Компоненти
- Інтерактивність API