Ugrás a tartalomhoz

Interaktivitás

A Blockstudio támogatja a WordPress Interactivity API elemet, amely szabványos módot kínál reaktív, kliensoldali viselkedés hozzáadására a blokkokhoz. Állítsd be a interactivity értéket a block.json fájlban, a Blockstudio pedig gondoskodik a API betöltéséről a frontendben és a szerkesztőben is.

Konfiguráció

Az Interactivity API engedélyezéséhez add hozzá a interactivity értéket a blockstudio kulcshoz a block.json fájlban:

JSON
{
  "name": "my-theme/interactive-block",
  "title": "Interactive Block",
  "category": "text",
  "icon": "star-filled",
  "description": "A block with interactive behavior.",
  "blockstudio": {
    "interactivity": true
  }
}

Az objektumformátumot is használhatod:

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

A két forma egyenértékű.

Sablon

Adj Interactivity API direktívákat a blokk sablonjához. A data-wp-interactive attribútum határozza meg a tároló névterét, a többi data-wp-* attribútum pedig a reaktív viselkedést vezérli.

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>

Szkript

Hozz létre egy script.js fájlt a blokk mappájában, importálj belőle a @wordpress/interactivity modulból, és inicializáld a tárolódat. Hívd meg a store() függvényt a modul legfelső szintjén:

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

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

A Blockstudio ES-modulként tölti be a script.js modult, és automatikusan létrehozza az @wordpress/interactivity feloldásához szükséges importleképezést.

script.js csak akkor szükséges, ha a blokk egyéni műveleteket vagy visszahívásokat határoz meg. Azok a blokkok, amelyek csak deklaratív direktívákat használnak data-wp-context-val/-vel (például data-wp-bind--hidden vagy data-wp-text), JavaScript nélkül is működnek.

Szerveroldali állapot

A PHP értékéből származó állapot inicializálásához használhatja a sablonban ezt: 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>

A szerveroldali állapot csak a frontend-en érhető el. A WordPress az állapotot egy JSON script címkébe szerializálja az oldal kimenetében, amelyet az Interactivity API olvas be a hidratálás során. A szerkesztőben a blokkok a REST API segítségével jelennek meg, ezért az állapotadatok nem kerülnek be a válaszba. Használja a data-wp-context elemet olyan állapothoz, amelynek a szerkesztőben és a frontend-en is működnie kell.

Visszahívások és műveletek

A műveleteket felhasználói interakciók (például data-wp-on--click) indítják el. A visszahívások az állapot vagy a kontextus változásakor, reaktívan futnak le a data-wp-watch direktíva használatával. A visszahívásokon belül a getElement() segítségével érheti el az alapul szolgáló DOM-elemet:

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

store('myBlock', {
  callbacks: {
    updateWidth: () => {
      const { ref } = getElement();
      const { isOpen } = getContext();
      ref.style.width = isOpen ? '100%' : '0';
    },
  },
});

Szerkesztői támogatás

Az Interactivity API a blokk szerkesztőjének iframe-jén belül töltődik be, így az interaktív direktívák a szerkesztői előnézetekben is működnek. Ide tartozik a data-wp-context, a data-wp-bind--*, a data-wp-on--*, a data-wp-text és a script.js alatt meghatározott egyéni tárolóműveletek.

Interaktív összetevők készítése

Teljes példák harmonikákkal, lapfülekkel, modális ablakokkal és kedvelés gombokkal.