Hoppa till innehåll

Interaktivitet

Blockstudio stöder WordPress Interactivity API, som erbjuder ett standardiserat sätt att lägga till reaktivt beteende på klientsidan i dina block. Ange interactivity i din block.json, så hanterar Blockstudio inläsningen av API både i frontend och i redigeraren.

Konfiguration

Aktivera Interactivity API genom att lägga till interactivity i nyckeln blockstudio i din block.json:

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 även använda objektformen:

JSON
{
  "blockstudio": {
    "interactivity": {
      "enqueue": true
    }
  }
}

Båda formerna är likvärdiga.

Mall

Lägg till direktiv för Interactivity API i blockmallen. Attributet data-wp-interactive definierar lagernamnrymden, och andra attribut för data-wp-* styr det reaktiva beteendet.

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

Skript

Skapa en fil av typen script.js i blockmappen. Importera från @wordpress/interactivity och initiera ditt lager. Anropa store() på modulens toppnivå:

JavaScript
import { store, getContext } from '@wordpress/interactivity';

store('myBlock', {
  actions: {
    toggle: () => {
      const context = getContext();
      context.isOpen = !context.isOpen;
    },
  },
});

Blockstudio läser in script.js som en ES-modul och genererar automatiskt den importkarta som behövs för att lösa @wordpress/interactivity.

En script.js behövs bara om ditt block definierar anpassade åtgärder eller återanrop. Block som bara använder deklarativa direktiv med data-wp-context (som data-wp-bind--hidden eller data-wp-text) fungerar utan någon JavaScript.

Tillstånd på serversidan

Du kan använda wp_interactivity_state() i din mall för att initiera tillstånd från PHP:

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>

Tillstånd på serversidan är bara tillgängligt i frontend. WordPress serialiserar tillståndet till en JSON-skripttagg i sidans utdata, som Interactivity API läser under hydrering. I redigeraren renderas block via REST API, så tillståndsdata ingår inte i svaret. Använd data-wp-context för tillstånd som behöver fungera både i redigeraren och i frontend.

Återanrop jämfört med åtgärder

Åtgärder utlöses av användarinteraktioner (som data-wp-on--click). Återanrop utlöses reaktivt när tillstånd eller kontext ändras, med direktivet data-wp-watch. Inuti återanrop kan du anropa getElement() för att komma åt det underliggande DOM-elementet:

JavaScript
import { store, getContext, getElement } from '@wordpress/interactivity';

store('myBlock', {
  callbacks: {
    updateWidth: () => {
      const { ref } = getElement();
      const { isOpen } = getContext();
      ref.style.width = isOpen ? '100%' : '0';
    },
  },
});

Stöd i redigeraren

Interactivity API laddas i blockredigerarens iframe, så interaktiva direktiv fungerar i förhandsvisningar i redigeraren. Detta omfattar data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text och anpassade butiksåtgärder som definieras i script.js.

Bygga interaktiva komponenter

Kompletta exempel med dragspel, flikar, modalfönster och gilla-knappar.