Перейти до вмісту

Інтерактивність

Blockstudio підтримує WordPress Interactivity API, що надає стандартний спосіб додавати реактивну поведінку на стороні клієнта до блоків. Укажіть interactivity у своєму block.json, а Blockstudio подбає про завантаження API як на зовнішній частині сайту, так і в редакторі.

Конфігурація

Увімкніть API Interactivity, додавши interactivity до ключа blockstudio у вашому 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
  }
}

Також можна використати форму об’єкта:

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

Обидві форми еквівалентні.

Шаблон

Додайте директиви Interactivity API до шаблону блоку. Атрибут data-wp-interactive визначає простір імен сховища, а інші атрибути data-wp-* керують реактивною поведінкою.

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.js у каталозі блоку, імпортуйте з @wordpress/interactivity та ініціалізуйте своє сховище. Викличте store() на верхньому рівні модуля:

JavaScript
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
<?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 у вихідному коді сторінки, який читає Interactivity API під час гідратації. У редакторі блоки рендеряться через REST API, тому дані стану не додаються до відповіді. Для стану, який має працювати і в редакторі, і на фронтенді, використовуйте data-wp-context.

Зворотні виклики та дії

Дії запускаються у відповідь на взаємодії користувача (наприклад, data-wp-on--click). Зворотні виклики запускаються реактивно, коли змінюється стан або контекст, за допомогою директиви data-wp-watch. Усередині зворотних викликів можна викликати getElement(), щоб отримати доступ до базового елемента DOM:

JavaScript
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.

Створення інтерактивних компонентів

Повні приклади з акордеонами, вкладками, модальними вікнами та кнопками вподобання.