Preskočiť na obsah

Interaktivita

Blockstudio podporuje InteractivityWordPress API, ktorý poskytuje štandardný spôsob pridávania reaktívneho správania na strane klienta do blokov. Nastavte interactivity vo svojom block.json a Blockstudio zabezpečí načítanie API na frontende aj v editore.

Konfigurácia

Interaktivitu API povoľte pridaním interactivity ku kľúču blockstudio v súbore 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 použiť aj objektovú formu:

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

Obe formy sú rovnocenné.

Šablóna

Pridajte direktívy API Interactivity do šablóny bloku. Atribút data-wp-interactive určuje menný priestor úložiska a ostatné atribúty data-wp-* ovládajú reaktívne správanie.

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

V priečinku svojho bloku vytvorte súbor script.js, ktorý importuje z @wordpress/interactivity a inicializuje váš store. Zavolajte store() na najvyššej úrovni modulu:

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

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

Blockstudio načíta script.js ako modul ES a automaticky vytvorí importmap potrebnú na rozlíšenie @wordpress/interactivity.

script.js je potrebný iba vtedy, ak váš blok definuje vlastné akcie alebo spätné volania. Bloky, ktoré používajú iba deklaratívne direktívy s data-wp-context (napríklad data-wp-bind--hidden alebo data-wp-text), fungujú aj bez JavaScript.

Stav na strane servera

Pomocou wp_interactivity_state() môžete v šablóne inicializovať 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 strane servera je dostupný iba na frontende. WordPress serializuje stav do značky skriptu JSON vo výstupe stránky, ktorú Interactivity API načíta počas hydratácie. V editore sa bloky vykresľujú prostredníctvom REST API, takže údaje o stave nie sú zahrnuté v odpovedi. Pre stav, ktorý má fungovať v editore aj na frontende, použite data-wp-context.

Spätné volania a akcie

Akcie sa spúšťajú interakciami používateľa (napríklad data-wp-on--click). Spätné volania sa spúšťajú reaktívne pri zmene stavu alebo kontextu pomocou direktívy data-wp-watch. V spätných volaniach môžete zavolať getElement() a získať prí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 editora

Interactivity API sa načíta vo vnútri iframe editora blokov, takže interaktívne direktívy fungujú v ukážkach editora. Patrí sem data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text a vlastné akcie store definované v script.js.

Tvorba interaktívnych komponentov

Kompletné príklady s rozbaľovacími panelmi, kartami, modálnymi oknami a tlačidlami Páči sa mi.