Aller au contenu

Interactivité

Blockstudio prend en charge WordPress Interactivity API, qui fournit une méthode standard pour ajouter un comportement réactif côté client à vos blocs. Définissez interactivity dans votre block.json, et Blockstudio se charge de charger le API à la fois sur le site et dans l’éditeur.

Configuration

Activez l’Interactivity API en ajoutant interactivity à la clé blockstudio de votre 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
  }
}

Vous pouvez aussi utiliser la forme objet :

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

Les deux formes sont équivalentes.

Modèle

Ajoutez des directives d’Interactivity API au modèle de votre bloc. L’attribut data-wp-interactive définit l’espace de noms du magasin, et les autres attributs data-wp-* contrôlent le comportement réactif.

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

Créez un fichier script.js dans le dossier de votre bloc, importez-y des éléments depuis @wordpress/interactivity et initialisez votre magasin. Appelez store() au niveau supérieur du module :

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

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

Blockstudio charge script.js en tant que module ES et génère automatiquement la carte d’importation nécessaire à la résolution de @wordpress/interactivity.

Un script.js est nécessaire uniquement si votre bloc définit des actions personnalisées ou des rappels. Les blocs qui utilisent uniquement des directives déclaratives avec data-wp-context (comme data-wp-bind--hidden ou data-wp-text) fonctionnent sans JavaScript.

État côté serveur

Vous pouvez utiliser wp_interactivity_state() dans votre modèle pour initialiser l’état à partir de 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>

L’état côté serveur est disponible uniquement sur l’interface publique. WordPress sérialise l’état dans une balise de script JSON dans le code de la page, que l’API d’interactivité lit pendant l’hydratation. Dans l’éditeur, les blocs sont rendus via le REST API ; les données d’état ne sont donc pas incluses dans la réponse. Utilisez data-wp-context pour l’état qui doit fonctionner dans l’éditeur et sur l’interface publique.

Rappels et actions

Les actions sont déclenchées par les interactions de l’utilisateur (comme data-wp-on--click). Les rappels sont déclenchés de manière réactive lorsque l’état ou le contexte change, à l’aide de la directive data-wp-watch. Dans les rappels, vous pouvez appeler getElement() pour accéder à l’élément DOM sous-jacent :

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

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

Prise en charge dans l’éditeur

L’API d’interactivité est chargé dans l’iframe de l’éditeur de blocs ; les directives interactives fonctionnent donc dans les aperçus de l’éditeur. Cela comprend data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text et les actions personnalisées du magasin définies dans script.js.

Créer des composants interactifs

Exemples complets avec des accordéons, des onglets, des fenêtres modales et des boutons J’aime.