Přejít k obsahu

Interaktivita

Blockstudio podporuje WordPress Interactivity API, která poskytuje standardní způsob přidávání reaktivního chování na straně klienta do vašich bloků. Nastavte interactivity ve svém block.json a Blockstudio se postará o načtení API na frontendu i v editoru.

Konfigurace

Povolte Interactivity API přidáním interactivity ke klíči blockstudio v souboru 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
  }
}

Můžete také použít podobu objektu:

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

Obě podoby jsou rovnocenné.

Šablona

Přidejte do šablony bloku direktivy Interactivity API. Atribut data-wp-interactive určuje jmenný prostor úložiště a ostatní atributy data-wp-* řídí reaktivní chování.

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>

Skript

Vytvořte ve složce bloku soubor script.js, který importuje z @wordpress/interactivity a inicializuje vaše úložiště. Zavolejte store() na nejvyšší úrovni modulu:

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

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

Blockstudio načte script.js jako modul ES a automaticky vytvoří importmap potřebnou k rozlišení @wordpress/interactivity.

script.js je potřeba pouze tehdy, pokud váš blok definuje vlastní akce nebo callbacky. Bloky, které používají jen deklarativní direktivy s data-wp-context (například data-wp-bind--hidden nebo data-wp-text), fungují bez JavaScript.

Stav na serveru

Pomocí wp_interactivity_state() můžete v šabloně inicializovat stav 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>

Stav na serveru je dostupný pouze na frontendu. WordPress serializuje stav do značky script JSON ve výstupu stránky, kterou Interactivity API načte během hydratace. V editoru se bloky vykreslují přes REST API, takže data stavu nejsou součástí odpovědi. Pro stav, který musí fungovat v editoru i na frontendu, použijte data-wp-context.

Callbacky a akce

Akce se spouštějí při interakcích uživatele (například data-wp-on--click). Callbacky se spouštějí reaktivně při změně stavu nebo kontextu pomocí direktivy data-wp-watch. Uvnitř callbacků můžete pomocí getElement() získat přístup k podkladovému prvku 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';
    },
  },
});

Podpora editoru

Interactivity API se načítá uvnitř iframe editoru bloků, takže interaktivní direktivy fungují v náhledech editoru. Patří mezi ně data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text a vlastní akce úložiště definované v script.js.

Vytváření interaktivních komponent

Kompletní příklady s rozbalovacími panely, kartami, modálními okny a tlačítky To se mi líbí.