Komponenter
Blockstudio levereras med 59 UI komponenter i varje bygge. De registreras automatiskt, formges med designtoken och skapas med samma taggsyntax som alla andra block.
Blockstudio 7.3 innehåller en samling huvudlösa UI-block som drivs av Interactivity-WordPressAPI. De registreras under namnrymden bsui/* och kan sättas samman i mallar, filbaserade sidor, mönster och inläggsinnehåll.
Obs!
UI-komponenterna är i betaversion medan vi samlar in synpunkter på komponentuppsättningen, namngivningen, beteendet och hur de används i projekt. De är redo att provas i version 7.3, men gränssnittet API kan fortfarande komma att förfinas innan det betecknas som stabilt.
Aktivera komponenter för UI
Komponenter för UI ingår som standard men måste aktiveras. Aktivera dem i ditt temas blockstudio.json:
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"ui": {
"enabled": true
}
}
Du kan också aktivera dem med ett filter:
add_filter('blockstudio/settings/ui/enabled', '__return_true');
När det är aktiverat registrerar Blockstudio komponentbiblioteket som ingår från includes/ui/blocks.
Offentlig förteckning och exempel
Implementationsblocken som ingår förblir vanliga bsui/*-registreringar, men
användare bör använda den offentliga förteckningen över familjer när de bygger ett komponentgalleri:
use Blockstudio\Ui;
$families = Ui::inventory();
$examples = Ui::examples();
Ui::inventory() grupperar varje sammansatt komponent under dess offentliga rot och
listar de implementeringsregistreringar som krävs för den familjen.
Ui::examples() lägger till en deterministisk, normaliserad deklaration med standarddata och
exempeldata. Den bevarar de obligatoriska relationerna mellan rot och underordnade element, så att
resultatet kan skickas direkt till Blockstudio\Render::document().
Den offentliga Canvas-förteckningen visar de här exemplen under typen ui
och utelämnar registreringar för implementeringsblock som ingår i den vanliga typen blocks. Därmed
blir det ett komplett exempel per offentlig komponentfamilj i stället för ett galleri
med interna rot-, utlösar-, popup- och lagerfragment.
När ett redan renderat dokument sätts samman returnerar Ui::global_assets($block_names, $html) exakt den globala stilen och det skript som ingår, men bara när den valda
utdata faktiskt använder en UI-komponent.
Rendering
Använd den vanliga blocktaggssyntaxen:
<block name="bsui/button" label="Save" variant="default"></block>
Den kortare syntaxen <bs:> fungerar också:
<bs:bsui-button label="Save" variant="default" />
I mallar för Blockstudio renderas blocktaggar automatiskt. På filbaserade sidor och i mönster synkroniseras de som inbyggda WordPress-block. Om du vill rendera komponenter för UI direkt från inläggsinnehåll eller widgetområden aktiverar du blocktaggar på sidnivå:
{
"ui": {
"enabled": true
},
"blockTags": {
"enabled": true,
"allow": ["bsui/*", "app/*"]
}
}
Grundläggande komponenter
Enkla komponenter renderas som ett enda block:
<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>
Attributen mappas direkt till attributen för varje komponents block.json. Till exempel stöder bsui/button label, icon, iconPosition, href, variant, size och disabled.
bs_render_block([
'name' => 'bsui/button',
'data' => [
'label' => 'Continue',
'icon' => [
'set' => 'heroicons',
'subSet' => 'outline',
'icon' => 'arrow-right',
],
'iconPosition' => 'right',
],
]);
Sammansatta komponenter
Många komponenter för UI består av sammansatta block. Rotblocket äger tillståndet, och underordnade block deklarerar sitt överordnade block.
Flikar
<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>
Dialogruta
<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>
Select
<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>
Formulärfält
<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>
Tillgängliga block
Biblioteket för UI som ingår omfattar:
| Område | Block |
|---|---|
| Layout | bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table |
| Åtgärder | bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar |
| Inmatning | 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 |
| Överlägg | bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip |
| Navigering | bsui/accordion, bsui/breadcrumb, bsui/carousel, bsui/collapsible, bsui/context-menu, bsui/navigation-menu, bsui/pagination, bsui/tabs |
| Feedback | bsui/badge, bsui/kbd, bsui/meter, bsui/progress, bsui/skeleton, bsui/spinner, bsui/text, bsui/toast |
| Formulär | bsui/field, bsui/field-group, bsui/form |
Sammansatta komponenter visar också underordnade block som bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup och bsui/select-option.
Formge
Komponenter för UI levereras med egna anpassade CSS-egenskaper som använder prefixet --bs-ui-*. Du kan åsidosätta dem från ditt tema CSS:
:root {
--bs-ui-radius: 0.5rem;
--bs-ui-primary: oklch(0.45 0.18 260);
--bs-ui-primary-foreground: white;
}
Komponenterna har inga fördefinierade beteenden, men är ändå tillräckligt bestämda för att kunna användas direkt. Börja med att åsidosätta token och lägg sedan till komponentspecifik CSS vid behov.
Komponentens CSS som ingår placeras i det namngivna kaskadlagret bsui. Olagrade
CSS i temat kan åsidosätta komponentregler utan !important:
.button-brand {
background: var(--brand-primary);
}
Om du vill lägga till en anpassad variant av bsui/button lägger du till select-alternativet med
attributfiltret som redan finns och anger variantens CSS med
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;
}';
});
Relaterat
- UIKomposition, inklusive styrda fält, fältkort och avgränsare i verktygsfält
- Programmatisk rendering
- Komponenter
- Interaktivitet API