Ga naar de inhoud

Interactiviteit

Blockstudio ondersteunt de WordPress Interactivity API, die een standaardmanier biedt om reactief gedrag aan de clientzijde aan uw blokken toe te voegen. Stel interactivity in uw block.json in; met Blockstudio wordt de API zowel op de frontend als in de editor geladen.

Configuratie

Schakel de Interactivity API in door interactivity toe te voegen aan de sleutel blockstudio in uw 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
  }
}

U kunt ook de objectvorm gebruiken:

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

Beide vormen zijn gelijkwaardig.

Template

Voeg Interactivity-richtlijnen van API toe aan uw bloktemplate. Het attribuut data-wp-interactive definieert de store-namespace; andere attributen van data-wp-* regelen reactief gedrag.

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>

Script

Maak een bestand van script.js in uw blokmap dat importeert uit @wordpress/interactivity en uw store initialiseert. Roep store() aan op het hoogste moduleniveau:

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

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

Blockstudio laadt script.js als een ES-module en genereert automatisch de importmap die nodig is om @wordpress/interactivity op te lossen.

Een script.js is alleen nodig als je blok aangepaste acties of callbacks definieert. Blokken die alleen declaratieve richtlijnen met data-wp-context gebruiken (zoals data-wp-bind--hidden of data-wp-text), werken zonder JavaScript.

Status aan de serverzijde

Je kunt wp_interactivity_state() in je template gebruiken om de status te initialiseren vanuit 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>

Status aan de serverzijde is alleen beschikbaar op de frontend. WordPress serialiseert de status naar een JSON-scripttag in de pagina-uitvoer, die de Interactivity API tijdens de hydratatie uitleest. In de editor worden blokken weergegeven via de REST API, dus de statusgegevens zijn niet opgenomen in het antwoord. Gebruik data-wp-context voor status die zowel in de editor als op de frontend moet werken.

Callbacks versus acties

Acties worden geactiveerd door gebruikersinteracties (zoals data-wp-on--click). Callbacks worden reactief geactiveerd wanneer de status of context verandert, met de richtlijn data-wp-watch. Binnen callbacks kun je getElement() aanroepen om toegang te krijgen tot het onderliggende DOM-element:

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

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

Ondersteuning voor de editor

De Interactivity API wordt geladen in het iframe van de blokeditor, zodat interactieve richtlijnen werken in editorvoorbeelden. Dit omvat data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text en aangepaste store-acties die zijn gedefinieerd in script.js.

Interactieve componenten bouwen

Volledige voorbeelden met accordeons, tabbladen, modals en like-knoppen.