Interactividad
Blockstudio es compatible con la WordPress Interactivity API, que ofrece una forma estándar de añadir comportamiento reactivo en el cliente a sus bloques. Configure interactivity en su block.json y Blockstudio se encargará de cargar el API tanto en el frontend como en el editor.
Configuración
Habilite la Interactivity API añadiendo interactivity a la clave blockstudio de su block.json:
{
"name": "my-theme/interactive-block",
"title": "Interactive Block",
"category": "text",
"icon": "star-filled",
"description": "A block with interactive behavior.",
"blockstudio": {
"interactivity": true
}
}
También puede usar la forma de objeto:
{
"blockstudio": {
"interactivity": {
"enqueue": true
}
}
}
Ambas formas son equivalentes.
Plantilla
Añada directivas de Interactivity API a la plantilla de su bloque. El atributo data-wp-interactive define el espacio de nombres del almacén y los demás atributos data-wp-* controlan el comportamiento reactivo.
<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
Cree un archivo script.js en la carpeta de su bloque que importe desde @wordpress/interactivity e inicialice su almacén. Llame a store() en el nivel superior del módulo:
import { store, getContext } from '@wordpress/interactivity';
store('myBlock', {
actions: {
toggle: () => {
const context = getContext();
context.isOpen = !context.isOpen;
},
},
});
Blockstudio carga script.js como módulo ES y genera automáticamente el mapa de importaciones necesario para resolver @wordpress/interactivity.
Solo se necesita un script.js si tu bloque define acciones o devoluciones de llamada personalizadas. Los bloques que solo usan directivas declarativas con data-wp-context (como data-wp-bind--hidden o data-wp-text) funcionan sin JavaScript.
Estado del servidor
Puedes usar wp_interactivity_state() en tu plantilla para inicializar el estado desde 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>
El estado del servidor solo está disponible en la interfaz pública. WordPress serializa el estado en una etiqueta de script JSON en el resultado de la página, que el API de Interactivity lee durante la hidratación. En el editor, los bloques se procesan mediante el REST API, por lo que los datos de estado no se incluyen en la respuesta. Usa data-wp-context para el estado que deba funcionar tanto en el editor como en la interfaz pública.
Devoluciones de llamada frente a acciones
Las acciones se activan mediante interacciones del usuario (como data-wp-on--click). Las devoluciones de llamada se activan de forma reactiva cuando cambia el estado o el contexto, mediante la directiva data-wp-watch. Dentro de las devoluciones de llamada, puedes llamar a getElement() para acceder al elemento DOM subyacente:
import { store, getContext, getElement } from '@wordpress/interactivity';
store('myBlock', {
callbacks: {
updateWidth: () => {
const { ref } = getElement();
const { isOpen } = getContext();
ref.style.width = isOpen ? '100%' : '0';
},
},
});
Compatibilidad con el editor
El API de Interactivity se carga dentro del iframe del editor de bloques, por lo que las directivas interactivas funcionan en las vistas previas del editor. Esto incluye data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text y las acciones personalizadas del almacén definidas en script.js.
Creación de componentes interactivos
Ejemplos completos con acordeones, pestañas, ventanas modales y botones de «Me gusta».