Interaktivitet
Blockstudio understøtter WordPress Interactivity API, som giver en standardiseret måde at tilføje reaktiv funktionalitet på klientsiden til dine blokke. Angiv interactivity i din block.json, så sørger Blockstudio for at indlæse API både på frontend og i editoren.
Konfiguration
Aktivér Interactivity API ved at føje interactivity til nøglen blockstudio i din block.json:
{
"name": "my-theme/interactive-block",
"title": "Interactive Block",
"category": "text",
"icon": "star-filled",
"description": "A block with interactive behavior.",
"blockstudio": {
"interactivity": true
}
}
Du kan også bruge objektformen:
{
"blockstudio": {
"interactivity": {
"enqueue": true
}
}
}
Begge former er ækvivalente.
Skabelon
Tilføj direktiver for Interactivity API til din blokskabelon. Attributten data-wp-interactive definerer navnerummet for store, mens andre attributter for data-wp-* styrer den reaktive funktionalitet.
<div useBlockProps
data-wp-interactive="myBlock"
data-wp-context='{ "isOpen": false }'>
<button data-wp-on--click="actions.toggle"
data-wp-bind--aria-expanded="context.isOpen">
Toggle
</button>
<div data-wp-bind--hidden="!context.isOpen">
This content is toggled by the button.
</div>
</div>
Script
Opret en fil af typen script.js i din blokmappe, som importerer fra @wordpress/interactivity og initialiserer dit store. Kald store() på øverste niveau i modulet:
import { store, getContext } from '@wordpress/interactivity';
store('myBlock', {
actions: {
toggle: () => {
const context = getContext();
context.isOpen = !context.isOpen;
},
},
});
Blockstudio indlæser script.js som et ES-modul og genererer automatisk det importmap, der skal bruges til at finde @wordpress/interactivity.
En script.js er kun nødvendig, hvis din blok definerer brugerdefinerede handlinger eller callbacks. Blokke, der kun bruger deklarative direktiver med data-wp-context (som data-wp-bind--hidden eller data-wp-text), fungerer uden JavaScript.
Tilstand på serversiden
Du kan bruge wp_interactivity_state() i din skabelon til at initialisere tilstand fra PHP:
<?php
wp_interactivity_state( 'myBlock', array(
'message' => 'Hello from the server',
'count' => get_comments_number(),
) );
?>
<div useBlockProps
data-wp-interactive="myBlock">
<p data-wp-text="state.message">loading...</p>
<p data-wp-text="state.count">0</p>
</div>
Tilstand på serversiden er kun tilgængelig på frontend. WordPress serialiserer tilstanden i et JSON-script-tag i sidens output, som Interactivity API læser under hydrering. I editoren gengives blokke via REST API, så tilstandsdataene medtages ikke i svaret. Brug data-wp-context til tilstand, der skal fungere både i editoren og på frontend.
Callbacks kontra handlinger
Handlinger udløses af brugerinteraktioner (som data-wp-on--click). Callbacks udløses reaktivt, når tilstand eller kontekst ændres, ved hjælp af direktivet data-wp-watch. I callbacks kan du kalde getElement() for at få adgang til det underliggende DOM-element:
import { store, getContext, getElement } from '@wordpress/interactivity';
store('myBlock', {
callbacks: {
updateWidth: () => {
const { ref } = getElement();
const { isOpen } = getContext();
ref.style.width = isOpen ? '100%' : '0';
},
},
});
Understøttelse i editoren
Interactivity API indlæses i blokeditorens iframe, så interaktive direktiver fungerer i editorens forhåndsvisninger. Det omfatter data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text og brugerdefinerede butikshandlinger defineret i script.js.
Bygning af interaktive komponenter
Komplette eksempler med harmonikaer, faner, modaler og like-knapper.