Gå til indhold

Komponenter

Blockstudio leveres med 59 UI-komponenter i hver build. De registreres automatisk, styles med designtokens og skrives med samme tagsyntaks som alle andre blokke.

Blockstudio 7.3 indeholder et indbygget sæt headless UI-blokke, der drives af WordPress Interactivity API. De er registreret under navnerummet bsui/* og kan sammensættes i skabeloner, filbaserede sider, mønstre og indlæg.

Bemærk

UI-komponenterne er i betaversion, mens vi indsamler feedback om komponentsættet, navngivningen, funktionaliteten og projektets brugsmønstre. De kan prøves i 7.3, men API-grænsefladen kan stadig blive justeret, før den erklæres stabil.

Aktivér UI-komponenter

De indbyggede UI-komponenter er valgfrie. Aktivér dem i dit temas blockstudio.json:

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

Eller aktivér dem med et filter:

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

Når Blockstudio er aktiveret, registrerer den komponentbiblioteket fra includes/ui/blocks.

Offentlig oversigt og eksempler

De indbyggede implementeringsblokke forbliver almindelige bsui/*-registreringer, men forbrugere bør bruge den offentlige oversigt over komponentfamilier, når de bygger et komponentgalleri:

PHP
use Blockstudio\Ui;

$families = Ui::inventory();
$examples = Ui::examples();

Ui::inventory() grupperer hver sammensat komponent under sin offentlige rod og viser de implementeringsregistreringer, som familien kræver. Ui::examples() tilføjer en deterministisk, normaliseret deklaration med standarddata og eksempeldata. Den bevarer de nødvendige relationer mellem rod og underordnede elementer, så resultatet kan sendes direkte til Blockstudio\Render::document().

Den offentlige oversigt over Canvas viser disse eksempler under sin ui-type og udelader indbyggede implementeringsregistreringer fra den almindelige blocks-type. Dermed får man ét komplet eksempel for hver offentlig komponentfamilie i stedet for et galleri med interne rod-, udløser-, popup- og lagfragmenter.

Når et allerede gengivet dokument sammensættes, returnerer Ui::global_assets($block_names, $html) kun den præcise indbyggede globale stil og det præcise script, hvis det valgte output faktisk bruger en UI-komponent.

Gengivelse

Brug den almindelige syntaks for bloktags:

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

Den kortere syntaks <bs:> virker også:

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

I Blockstudio-skabeloner gengives bloktags automatisk. På filbaserede sider og i mønstre synkroniseres de som indbyggede WordPress-blokke. Hvis du vil gengive UI-komponenter direkte fra indlægsindhold eller widgetområder, skal du aktivere bloktags på sideniveau:

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

Grundlæggende komponenter

Enkle komponenter gengives som en enkelt blok:

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>

Attributter knyttes direkte til hver komponents block.json-attributter. For eksempel understøtter bsui/button label, icon, iconPosition, href, variant, size og disabled.

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

Sammensatte komponenter

Mange UI-komponenter består af flere blokke. Rodblokken ejer tilstanden, og underordnede blokke angiver deres forælder.

Faneblade

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>

Dialog

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>

Vælger

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>

Formularfelter

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>

Tilgængelige blokke

Det indbyggede UI-bibliotek omfatter:

Område Blokke
Layout bsui/aspect-ratio, bsui/card, bsui/separator, bsui/stack, bsui/table
Handlinger bsui/button, bsui/button-group, bsui/toggle, bsui/toggle-group, bsui/toolbar
Inputfelter 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
Overlejringer bsui/alert-dialog, bsui/dialog, bsui/drawer, bsui/menu, bsui/menubar, bsui/popover, bsui/preview-card, bsui/tooltip
Navigation 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
Formularer bsui/field, bsui/field-group, bsui/form

Sammensatte komponenter viser også underordnede blokke som bsui/dialog-trigger, bsui/dialog-popup, bsui/tabs-list, bsui/tabs-trigger, bsui/tabs-panel, bsui/select-trigger, bsui/select-popup og bsui/select-option.

Styling

UI-komponenter leveres med deres egne brugerdefinerede CSS-egenskaber med præfikset --bs-ui-*. Du kan tilsidesætte dem i dit temas CSS:

CSS
:root {
  --bs-ui-radius: 0.5rem;
  --bs-ui-primary: oklch(0.45 0.18 260);
  --bs-ui-primary-foreground: white;
}

Komponenternes funktion er headless, men de har nok faste valg til at kunne bruges direkte. Tilsidesæt tokens først, og tilføj derefter komponentspecifikke CSS efter behov.

Indbygget komponent-CSS udsendes i det navngivne bsui-kaskadelag. Ulagdelt tema-CSS kan tilsidesætte komponentregler uden !important:

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

Hvis du vil tilføje en brugerdefineret variant af bsui/button, skal du tilføje vælgermuligheden med det eksisterende attributfilter og angive 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;
}';
});

Alle komponenter

Harmonika Stablede sektioner, hvor ét panel udvides ad gangen. Advarselsdialog En modal, der afbryder forløbet og kræver et svar, før den lukker. Højde-bredde-forhold Begrænser indholdet til et fast forhold mellem bredde og højde. Avatar Et brugerbillede, der viser initialer, hvis det ikke kan indlæses. Badge En lille etiket til status, antal og kategorier. Brødkrumme Viser den aktuelle sides placering i hierarkiet. Knap Udløser en handling med varianter til alle niveauer af fremhævelse. Knapgruppe Samler relaterede knapper i én opdelt kontrol. Kalender Et datogitter til valg af én dag. Kort En flade, der grupperer en sidehoved, brødtekst og sidefod. Karussel Et spor med slides, der kan stryges igennem og betjenes med tastaturet. Afkrydsningsfelt Et binært valg, der også understøtter en uafklaret tilstand. Sammenklappelig Skjuler og viser et enkelt indholdsområde. Farvevælger Vælger en farve og sender den med den omgivende formular. Kombinationsboks Et tekstfelt, der filtrerer en liste over valgmuligheder, mens du skriver. Genvejsmenu Handlinger, der vises ved højreklik og forankres ved markøren. Datoinput Et maskeret felt til indtastning af datoer uden en vælger. Dialog Et modallag til fokuserede opgaver og bekræftelser. Skuffe Et panel, der glider ind fra en vilkårlig skærmkant. Felt Samler én kontrol med dens etiket, beskrivelse og fejlmeddelelse. Feltgruppe Grupperer relaterede felter under en fælles titel. Filupload Et slipområde og en filvælger med understøttelse af flere filer. Formular Sender felterne og rapporterer succes uden at genindlæse siden. Input Et tekstfelt på én linje til alle almindelige inputtyper. Tastaturgenvej Viser en tastaturgenvej i sin egen tast. Etiket En billedtekst til en kontrol, der deles af alle komponenter med etiketter. Menu En rullemenu med handlinger, forankret ved en udløser. Menulinje En vandret menulinje som i et skrivebordsprogram. Måler Viser en måling inden for et kendt interval. Navigationsmenu Webstedsnavigation med indlejrede links og paneler ved hover. Tal-felt Et numerisk input med trinvis justering og et begrænset interval. Engangskodefelt Opdelte felter til indtastning af en engangskode. Paginering Sidelinks med forrige, næste og udeladelser. Adgangskodefelt Et adgangskodefelt med en knap til at vise adgangskoden. Telefonfelt Et telefonfelt med valg af land og formatering. Pop op Rigt indhold forankret ved en udløser, som lukkes ved klik udenfor. Forhåndsvisningskort Et hoverkort, der viser en forhåndsvisning af linkets mål. Fremskridt Viser, hvor langt en opgave er nået. Gruppe af alternativknapper Et sæt valgmuligheder, hvor præcis én kan vælges. Bedømmelse En stjernekontrol til at registrere en bedømmelse. Rulleområde En rullebeholder med formaterede rullebjælker, der ligger oven på indholdet. Vælg En rullemenu til valg fra en liste over muligheder. Skillelinje En linje, der adskiller indhold eller grupper af kontroller. Skelet En pladsholderform, der vises, mens indholdet indlæses. Skyder Vælger en værdi eller et interval ved at trække langs et spor. Mellemrum Et fast trin i den lodrette rytme fra afstandsskalaen. Spinner Angiver, at arbejde er i gang, uden kendt varighed. Stak Arrangerer underordnede elementer i en række eller kolonne med ensartet afstand. Kontakt Slår en indstilling til eller fra, så ændringen træder i kraft med det samme. Tabel Tabeldata med valgfri sortering og stribede rækker. Faner Skifter mellem paneler, der optager samme plads. Text Viser brødtekst i en valgt størrelse og semantisk tag. Tekstområde Et tekstfelt med flere linjer, der vokser med antallet af rækker. Tidsvælger Vælger et tidspunkt på dagen med et valgt interval. Toast-udbyder Viser midlertidige beskeder i et hjørne af skærmen. Skift En knap, der forbliver trykket ned for at vise en aktiveret tilstand. Skifteknapgruppe Et sæt kontakter, der fungerer som enkelt- eller flervalg. Værktøjslinje En række kontroller med fokus, der flyttes mellem dem. Værktøjstip Et kort tip, der vises ved hover eller fokus.