Preskoči na vsebino

Interaktivnost

Blockstudio podpira WordPress Interactivity API, ki zagotavlja standardni način dodajanja odzivnega delovanja na strani odjemalca v vaše bloke. V block.json nastavite interactivity, za nalaganje API tako na zunanjem delu kot v urejevalniku pa poskrbi Blockstudio.

Konfiguracija

Omogočite Interactivity API tako, da v svojem block.json dodate interactivity v ključ blockstudio:

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

Uporabite lahko tudi obliko objekta:

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

Obe obliki sta enakovredni.

Predloga

V predlogo bloka dodajte direktive Interactivity API. Atribut data-wp-interactive določa imenski prostor shrambe, drugi atributi data-wp-* pa nadzorujejo odzivno delovanje.

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 mapi bloka ustvarite datoteko script.js, ki uvaža iz @wordpress/interactivity in inicializira vašo shrambo. Pokličite store() na najvišji ravni modula:

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

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

Blockstudio naloži script.js kot modul ES in samodejno ustvari importmap, potreben za razreševanje @wordpress/interactivity.

script.js potrebujete le, če vaš blok določa dejanja po meri ali povratne klice. Bloki, ki uporabljajo samo deklarativne direktive z data-wp-context (kot sta data-wp-bind--hidden ali data-wp-text), delujejo brez JavaScript.

Stanje na strežniku

V predlogi lahko uporabite wp_interactivity_state() za inicializacijo stanja iz 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>

Stanje na strežniku je na voljo samo na sprednjem delu. WordPress serializira stanje v oznako skripta JSON v izhodu strani, ki jo Interactivity API prebere med hidracijo. V urejevalniku se bloki izrišejo prek REST API, zato podatki stanja niso vključeni v odgovor. Za stanje, ki mora delovati v urejevalniku in na sprednjem delu, uporabite data-wp-context.

Povratni klici in dejanja

Dejanja se sprožijo ob interakcijah uporabnika (na primer data-wp-on--click). Povratni klici se sprožijo reaktivno ob spremembi stanja ali konteksta z direktivo data-wp-watch. Znotraj povratnih klicev lahko uporabite getElement() za dostop do osnovnega elementa 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 v urejevalniku

Interactivity API se naloži v iframe urejevalnika blokov, zato interaktivne direktive delujejo v predogledih urejevalnika. To vključuje data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text in dejanja shrambe po meri, določena v script.js.

Izdelava interaktivnih komponent

Celoviti primeri harmonik, zavihkov, modalnih oken in gumbov »Všeč mi je«.