Przejdź do treści

Interaktywność

Blockstudio obsługuje WordPress Interactivity API, które zapewnia standardowy sposób dodawania reaktywnego działania po stronie klienta do bloków. Ustaw interactivity w pliku block.json, a Blockstudio zajmie się ładowaniem API zarówno w interfejsie, jak i w edytorze.

Konfiguracja

Włącz API Interactivity, dodając interactivity do klucza blockstudio w pliku 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
  }
}

Możesz też użyć formy obiektowej:

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

Obie formy są równoważne.

Szablon

Dodaj dyrektywy Interactivity API do szablonu bloku. Atrybut data-wp-interactive określa przestrzeń nazw magazynu, a pozostałe atrybuty data-wp-* sterują reaktywnym działaniem.

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>

Skrypt

Utwórz plik script.js w katalogu bloku, zaimportuj z @wordpress/interactivity i zainicjuj swój magazyn. Wywołaj store() na najwyższym poziomie modułu:

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

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

Blockstudio ładuje script.js jako moduł ES i automatycznie generuje mapę importów potrzebną do rozwiązania @wordpress/interactivity.

Element script.js jest potrzebny tylko wtedy, gdy blok definiuje własne akcje lub funkcje zwrotne. Bloki używające wyłącznie deklaratywnych dyrektyw z data-wp-context (takich jak data-wp-bind--hidden lub data-wp-text) działają bez JavaScript.

Stan po stronie serwera

Możesz użyć wp_interactivity_state() w szablonie, aby zainicjować stan z 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>

Stan po stronie serwera jest dostępny tylko na frontendzie. WordPress serializuje stan do tagu skryptu JSON w kodzie strony, który Interactivity API odczytuje podczas hydracji. W edytorze bloki są renderowane przez REST API, dlatego dane stanu nie są dołączane do odpowiedzi. Użyj data-wp-context w przypadku stanu, który ma działać zarówno w edytorze, jak i na frontendzie.

Funkcje zwrotne a akcje

Akcje są wyzwalane przez interakcje użytkownika (takie jak data-wp-on--click). Funkcje zwrotne są wyzwalane reaktywnie po zmianie stanu lub kontekstu za pomocą dyrektywy data-wp-watch. Wewnątrz funkcji zwrotnych możesz wywołać getElement(), aby uzyskać dostęp do bazowego elementu 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';
    },
  },
});

Obsługa edytora

Interactivity API jest ładowane w ramce iframe edytora bloków, więc dyrektywy interaktywne działają w podglądach edytora. Dotyczy to data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text oraz własnych akcji magazynu zdefiniowanych w script.js.

Tworzenie interaktywnych komponentów

Kompletne przykłady z akordeonami, kartami, oknami modalnymi i przyciskami polubienia.