Интерактивност
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 модул и автоматично генерира importmap, необходим за разрешаването на @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 script tag в изхода на страницата, който 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 се зарежда във вградения iframe на редактора на блокове, така че интерактивните директиви работят в предварителните прегледи на редактора. Това включва data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text и персонализираните действия в хранилището, дефинирани в script.js.
Създаване на интерактивни компоненти
Пълни примери с акордеони, раздели, модални прозорци и бутони за харесване.