Treci la conținut

Interactivitate

Blockstudio acceptă WordPress Interactivity API, care oferă o metodă standard de adăugare a unui comportament reactiv, pe partea clientului, blocurilor dvs. Setați interactivity în block.json, iar Blockstudio se ocupă de încărcarea API atât în frontend, cât și în editor.

Configurare

Activați API Interactivity adăugând interactivity la cheia blockstudio din 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
  }
}

Puteți folosi și forma obiect:

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

Ambele forme sunt echivalente.

Șablon

Adăugați directive API Interactivity la șablonul blocului. Atributul data-wp-interactive definește spațiul de nume al magazinului, iar celelalte atribute data-wp-* controlează comportamentul reactiv.

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

Creați un fișier script.js în dosarul blocului, importați din @wordpress/interactivity și inițializați magazinul. Apelați store() la nivelul superior al modulului:

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

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

Blockstudio încarcă script.js ca modul ES și generează automat importmap-ul necesar pentru rezolvarea @wordpress/interactivity.

Un script.js este necesar doar dacă blocul definește acțiuni sau callbackuri personalizate. Blocurile care folosesc doar directive declarative cu data-wp-context (precum data-wp-bind--hidden sau data-wp-text) funcționează fără niciun JavaScript.

Starea pe server

Puteți folosi wp_interactivity_state() în șablon pentru a inițializa starea din 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>

Starea de pe server este disponibilă doar în frontend. WordPress serializează starea într-o etichetă script JSON în ieșirea paginii, pe care API de interactivitate o citește în timpul hidratării. În editor, blocurile sunt randate prin REST API, așadar datele stării nu sunt incluse în răspuns. Folosiți data-wp-context pentru starea care trebuie să funcționeze atât în editor, cât și în frontend.

Callbackuri și acțiuni

Acțiunile sunt declanșate de interacțiunile utilizatorului (precum data-wp-on--click). Callbackurile sunt declanșate reactiv atunci când se schimbă starea sau contextul, folosind directiva data-wp-watch. În callbackuri, puteți apela getElement() pentru a accesa elementul DOM subiacent:

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

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

Compatibilitate cu editorul

API de interactivitate este încărcat în iframe-ul editorului de blocuri, astfel încât directivele interactive funcționează în previzualizările editorului. Sunt incluse data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text și acțiunile personalizate ale magazinului definite în script.js.

Crearea componentelor interactive

Exemple complete cu acordeoane, file, ferestre modale și butoane de apreciere.