Към съдържанието

Компоненти

Blockstudio включва 59 UI компонента във всяка компилация. Те се регистрират автоматично, стилизират се с токени за дизайн и се създават със същия синтаксис на тагове като всеки друг блок.

Blockstudio 7.3 включва пакет от безглави блокове UI, задвижвани от WordPress Interactivity API. Те са регистрирани в пространството от имена bsui/* и могат да се комбинират в шаблони, файлови страници, образци и съдържание на публикации.

Забележка

Компонентите UI са в бета-версия, докато събираме обратна връзка за набора от компоненти, именуването, поведението и моделите на използване в проектите. Могат да се изпробват във версия 7.3, но интерфейсът API може да бъде променен, преди да бъде обявен за стабилен.

Активиране на компонентите UI

Пакетните компоненти UI са незадължителни. Активирайте ги в blockstudio.json на темата си:

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

Или ги активирайте с филтър:

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

Когато са активирани, Blockstudio регистрира библиотеката от пакетни компоненти от includes/ui/blocks.

Публичен списък и примери

Пакетните блокове за реализация остават обичайни регистрации bsui/*, но при изграждането на галерия от компоненти трябва да се използва публичният списък на компонентите:

PHP
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.

Визуализиране

Използвайте обичайния синтаксис на таговете за блокове:

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

Също така работи и съкратеният синтаксис <bs:>:

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

В шаблоните Blockstudio таговете за блокове се визуализират автоматично. Във файлови страници и образци те се синхронизират като вградени блокове WordPress. За да визуализирате компоненти UI директно от съдържанието на публикация или области с уиджети, активирайте таговете за блокове на ниво страница:

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

Основни компоненти

Простите компоненти се визуализират като един блок:

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>

Атрибутите се съпоставят директно с атрибутите block.json на всеки компонент. Например bsui/button поддържа label, icon, iconPosition, href, variant, size и disabled.

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

Съставни компоненти

Много компоненти UI се състоят от няколко блока. Коренният блок управлява състоянието, а дъщерните блокове декларират своя родител.

Раздели

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>

Диалогов прозорец

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>

Списък за избор

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>

Полета на формуляра

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>

Налични блокове

Пакетната библиотека 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 на темата си:

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:

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

За да добавите персонализиран вариант bsui/button, добавете опция за списъка за избор със съществуващия филтър за атрибути и предоставете варианта CSS с 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;
}';
});

Всички компоненти

Акордеон Подредени раздели, които разгръщат по един панел. Предупредителен диалог Модален прозорец, който прекъсва работния процес и изисква отговор, преди да се затвори. Пропорции Ограничава съдържанието до фиксирано съотношение ширина към височина. Аватар Изображение на потребител, за което при неуспешно зареждане се показват инициалите му. Значка Малък етикет за състояние, брой и категории. Навигационна пътека Показва мястото на текущата страница в йерархията. Бутон Извиква действие с варианти за различни нива на акцент. Група бутони Обединява свързани бутони в един контролиран елемент от сегменти. Календар Календарна мрежа за избор на един ден. Карта Контейнер, който групира заглавка, основно съдържание и долен колонтитул. Въртележка Плъзгаема лента със слайдове и поддръжка на клавиатура. Поле за отметка Двоичен избор, който поддържа и неопределено състояние. Сгъваем Скрива и показва една област със съдържание. Избор на цвят Избира цвят и го изпраща с околния формуляр. Комбинирано поле Текстово поле, което филтрира списък с опции, докато пишете. Контекстно меню Действия, показвани при щракване с десния бутон и разположени при показалеца. Поле за въвеждане на дата Маскирано поле за въвеждане на дати без календар. Диалогов прозорец Модален слой за задачи, изискващи внимание, и потвърждения. Странично чекмедже Панел, който се плъзга от произволен край на екрана. Поле Обгръща един контрол с етикет, описание и съобщение за грешка. Група полета Групира свързани полета под общо заглавие. Качване на файл Зона за пускане и избор на файлове с поддръжка на няколко файла. Формуляр Изпраща полетата и показва успех без презареждане. Входни данни Едноредово текстово поле за всички често използвани типове вход. Клавишна комбинация Показва клавишна комбинация в отделно поле за клавиш. Етикет Надпис за контрол, споделен от всички компоненти с етикет. Меню Падащ списък с действия, прикрепен към елемент за отваряне. Лента с менюта Хоризонтална лента с менюта като в настолно приложение. Измервател Показва измерена стойност в известен диапазон. Навигационно меню Навигация на сайта с вложени връзки и панели при посочване. Поле за число Числово поле със стъпкови бутони и ограничен диапазон. Поле за еднократен код Разделени полета за въвеждане на еднократен код. Странициране Връзки към страници с предишна, следваща и съкратен списък. Поле за парола Поле за парола с бутон за показване. Поле за телефон Поле за телефон с избор на държава и форматиране. Изскачащ панел Форматирано съдържание, прикрепено към елемент за отваряне и затваряно с щракване извън него. Карта за преглед Карта при посочване, която показва предварителен преглед на целта на връзката. Напредък Показва докъде е стигнала дадена задача. Група радиобутони Набор от опции, от които може да се избере точно една. Оценка Контрол със звезди за задаване на оценка. Област с превъртане Контейнер за превъртане със стилизирани ленти за превъртане върху съдържанието. Изберете Падащ списък за избор от набор с опции. Разделител Линия, която разделя съдържание или групи от контроли. Скелетон Форма заместител, която се показва, докато съдържанието се зарежда. Плъзгач Избира стойност или диапазон чрез плъзгане по писта. Интервал Фиксирана стъпка във вертикалния ритъм от скалата за отстояния. Въртящ се индикатор Показва текуща работа с неизвестна продължителност. Стек Подрежда дъщерните елементи в ред или колона с равномерни отстояния. Превключвател Превключва настройка, която се прилага незабавно. Таблица Таблични данни с незадължително сортиране и редуващи се фонове. Раздели Превключва между панели, заемащи едно и също място. Text Извежда текст с избран размер и семантичен елемент. Текстова област Многоредово текстово поле, което расте според броя редове. Избор на час Избира час от деня с избрана стъпка. Доставчик на известия Показва временни известия в ъгъл на екрана. Превключване Бутон, който остава натиснат, за да представя включено състояние. Група превключватели Набор от превключватели, работещи като избор на един или няколко елемента. Лента с инструменти Ред от контроли с преместване на фокуса между тях. Подсказка Кратка подсказка, показвана при посочване или фокусиране.