Hoppa till innehåll

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:

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

Du kan också aktivera dem med ett filter:

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

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

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

Den kortare syntaxen <bs:> fungerar också:

HTML
<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å:

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

Grundläggande komponenter

Enkla komponenter renderas som ett enda block:

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>

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.

PHP
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

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>

Dialogruta

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>

Select

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>

Formulärfält

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>

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:

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:

CSS
.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:

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

Alla komponenter

Dragspel Staplar sektioner där en panel i taget fälls ut. Varningsdialog En modal som avbryter flödet och kräver ett svar innan den stängs. Bildförhållande Begränsar innehållet till ett fast bredd-höjdförhållande. Avatar En användarbild som ersätts med initialer om den inte kan läsas in. Märke En liten etikett för status, antal och kategorier. Brödsmulor Visar den aktuella sidans plats i hierarkin. Knapp Utlöser en åtgärd, med varianter för olika grader av betoning. Knappgrupp Samlar relaterade knappar i en enda segmenterad kontroll. Kalender Ett datumrutnät för att välja en enskild dag. Kort En yta som grupperar en rubrik, en brödtext och en sidfot. Karusell Ett svepbart bildspel med stöd för tangentbord. Kryssruta Ett binärt val som även stöder ett obestämt tillstånd. Fällbar Döljer och visar ett enda innehållsområde. Färgväljare Väljer en färg och skickar den med det omgivande formuläret. Kombinationsruta Ett textfält som filtrerar en lista med alternativ medan du skriver. Snabbmeny Åtgärder som visas vid högerklick och förankras vid pekaren. Datuminmatning Ett maskerat fält för att skriva datum utan en väljare. Dialogruta Ett modalt lager för fokuserade uppgifter och bekräftelser. Utdragbar panel En panel som glider in från valfri skärmkant. Fält Omsluter en kontroll med etikett, beskrivning och felmeddelande. Fältgrupp Grupperar relaterade fält under en gemensam rubrik. Filuppladdning En släppzon och filväljare med stöd för flera filer. Formulär Skickar fälten och rapporterar att det lyckades utan att sidan laddas om. Indata Ett textfält på en rad för alla vanliga indatatyper. Kortkommando Visar ett kortkommando i en egen tangentknapp. Etikett En bildtext för en kontroll som delas av alla komponenter med etikett. Meny En rullgardinslista med åtgärder, förankrad vid en utlösare. Menyrad En horisontell menyrad, som i ett datorprogram. Mätare Visar ett mått inom ett känt intervall. Navigeringsmeny Webbplatsnavigering med kapslade länkar och paneler som visas vid hovring. Numeriskt fält Ett numeriskt fält med stegningsknappar och begränsat intervall. OTP-inmatning Uppdelade rutor för att ange en engångskod. Sidnumrering Sidnavigering med föregående, nästa och förkortning. Lösenordsfält Ett lösenordsfält med en växel för att visa lösenordet. Telefonfält Ett telefonfält med landsval och formatering. Popup Rikt innehåll förankrat vid en utlösare och stängt vid klick utanför. Förhandsgranskningskort Ett hovringskort som förhandsvisar vart en länk leder. Förlopp Visar hur långt ett arbete har kommit. Grupp med alternativknappar En uppsättning alternativ där exakt ett kan väljas. Betyg En stjärnkontroll för att ange ett betyg. Rullningsområde En rullningsbehållare med formaterade rullningslister ovanpå innehållet. Välj En rullgardinslista för att välja bland flera alternativ. Avdelare En linje som delar upp innehåll eller grupper av kontroller. Skelett En platshållarform som visas medan innehåll läses in. Reglage Väljer ett värde eller ett intervall genom att dra längs ett spår. Mellanrum Ett fast steg i den vertikala rytmen från avståndsskalan. Snurra Visar att arbete pågår utan känd varaktighet. Stapel Lägger ut underordnade element i en rad eller kolumn med jämna mellanrum. Växel Växlar en inställning som tillämpas direkt. Tabell Tabellformaterade data med valfri sortering och randning. Flikar Växlar mellan paneler som upptar samma utrymme. Text Visar löptext med vald storlek och semantisk tagg. Textområde Ett textfält med flera rader som växer med antalet rader. Tidsväljare Väljer en tid på dagen med ett valt intervall. Toast-leverantör Visar tillfälliga aviseringar i ett hörn av skärmen. Växling En knapp som förblir nedtryckt för att representera ett påslaget läge. Växelgrupp En uppsättning växlar för ett eller flera val. Verktygsfält En rad med kontroller där fokus kan flyttas mellan dem. Infotext En kort ledtråd som visas vid hovring eller fokus.