Интерактивность
Blockstudio поддерживает WordPress Interactivity API, который предоставляет стандартный способ добавления реактивного поведения на стороне клиента в ваши блоки. Укажите interactivity в вашем block.json, а Blockstudio загрузит API как во внешней части сайта, так и в редакторе.
Настройка
Включите Interactivity API, добавив interactivity в ключ blockstudio файла block.json:
{
"name": "my-theme/interactive-block",
"title": "Interactive Block",
"category": "text",
"icon": "star-filled",
"description": "A block with interactive behavior.",
"blockstudio": {
"interactivity": true
}
}
Можно также использовать форму объекта:
{
"blockstudio": {
"interactivity": {
"enqueue": true
}
}
}
Обе формы равнозначны.
Шаблон
Добавьте директивы Interactivity API в шаблон блока. Атрибут data-wp-interactive задаёт пространство имён хранилища, а другие атрибуты data-wp-* управляют реактивным поведением.
<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.js в папке блока, импортируйте из @wordpress/interactivity и инициализируйте хранилище. Вызовите store() на верхнем уровне модуля:
import { store, getContext } from '@wordpress/interactivity';
store('myBlock', {
actions: {
toggle: () => {
const context = getContext();
context.isOpen = !context.isOpen;
},
},
});
Blockstudio загружает script.js как модуль ES и автоматически создаёт карту импортов, необходимую для разрешения @wordpress/interactivity.
script.js нужен только в том случае, если ваш блок определяет пользовательские действия или обратные вызовы. Блоки, в которых используются только декларативные директивы с data-wp-context (например, data-wp-bind--hidden или data-wp-text), работают без JavaScript.
Состояние на сервере
В шаблоне можно использовать wp_interactivity_state(), чтобы инициализировать состояние из 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>
Состояние на сервере доступно только на внешней части сайта. WordPress сериализует состояние в тег скрипта JSON в HTML-коде страницы, который Interactivity API считывает при гидратации. В редакторе блоки отображаются через REST API, поэтому данные состояния не включаются в ответ. Используйте data-wp-context для состояния, которое должно работать и в редакторе, и на внешней части сайта.
Обратные вызовы и действия
Действия запускаются при взаимодействии с пользователем (например, data-wp-on--click). Обратные вызовы запускаются реактивно при изменении состояния или контекста с помощью директивы data-wp-watch. Внутри обратных вызовов можно вызвать getElement(), чтобы получить доступ к базовому элементу DOM:
import { store, getContext, getElement } from '@wordpress/interactivity';
store('myBlock', {
callbacks: {
updateWidth: () => {
const { ref } = getElement();
const { isOpen } = getContext();
ref.style.width = isOpen ? '100%' : '0';
},
},
});
Поддержка редактора
Interactivity API загружается во фрейме редактора блоков, поэтому интерактивные директивы работают в предварительном просмотре редактора. Это относится к data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text и пользовательским действиям хранилища, определенным в script.js.
Создание интерактивных компонентов
Готовые примеры аккордеонов, вкладок, модальных окон и кнопок «Нравится».