Компоненты
Blockstudio включает 59 UI компонентов в каждой сборке. Они регистрируются автоматически, оформляются с помощью дизайн-токенов и создаются с тем же синтаксисом тегов, что и любые другие блоки.
Blockstudio 7.3 включает набор готовых блоков UI без интерфейса, работающих на основе WordPress Interactivity 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