Siirry sisältöön

Vuorovaikutteisuus

Blockstudio tukee WordPress-vuorovaikutteisuus-API-toimintoa, joka tarjoaa vakiotavan lisätä lohkoihisi reaktiivista toimintaa asiakaspuolella. Määritä interactivity kohteessa block.json, niin Blockstudio huolehtii kohteen API lataamisesta sekä käyttöliittymässä että editorissa.

Määritykset

Ota vuorovaikutteisuus-API käyttöön lisäämällä interactivity kohteen blockstudio avaimeen tiedostossa 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
  }
}

Voit käyttää myös objektimuotoa:

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

Molemmat muodot ovat samanarvoisia.

Malli

Lisää vuorovaikutteisuus-API-direktiivejä lohkomalliisi. Attribuutti data-wp-interactive määrittää kaupan nimiavaruuden, ja muut data-wp-*-attribuutit ohjaavat reaktiivista toimintaa.

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>

Komentosarja

Luo script.js-tiedosto lohkosi kansioon, tuo siihen kohteesta @wordpress/interactivity ja alusta kauppasi. Kutsu toimintoa store() moduulin ylimmällä tasolla:

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

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

Blockstudio lataa kohteen script.js ES-moduulina ja luo automaattisesti tuontikartan, jota tarvitaan kohteen @wordpress/interactivity ratkaisemiseen.

script.js tarvitaan vain, jos lohkosi määrittää mukautettuja toimintoja tai takaisinsoittoja. Lohkot, jotka käyttävät vain deklaratiivisia direktiivejä, kuten data-wp-context (esimerkiksi data-wp-bind--hidden tai data-wp-text), toimivat ilman JavaScript-ominaisuutta.

Palvelinpuolen tila

Voit alustaa tilan mallissasi arvosta PHP käyttämällä wp_interactivity_state()-ominaisuutta:

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>

Palvelinpuolen tila on käytettävissä vain käyttöliittymässä. WordPress sarjoittaa tilan sivun tulosteeseen sijoitettavaan JSON script-tunnisteeseen, jonka Interactivity API lukee hydratoitaessa. Muokkaimessa lohkot renderöidään REST API -toiminnon kautta, joten tilatiedot eivät sisälly vastaukseen. Käytä data-wp-context-ominaisuutta tilalle, jonka on toimittava sekä muokkaimessa että käyttöliittymässä.

Takaisinsoitot ja toiminnot

Toiminnot käynnistyvät käyttäjän toimista (kuten data-wp-on--click). Takaisinsoitot käynnistyvät reaktiivisesti, kun tila tai konteksti muuttuu, käyttäen data-wp-watch-direktiiviä. Takaisinsoittojen sisällä voit käyttää getElement()-toimintoa taustalla olevan DOM-elementin käyttämiseen:

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

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

Muokkaimen tuki

Interactivity API ladataan lohkomuokkaimen iframe-kehykseen, joten vuorovaikutteiset direktiivit toimivat muokkaimen esikatseluissa. Tämä koskee ominaisuuksia data-wp-context, data-wp-bind--*, data-wp-on--* ja data-wp-text sekä mukautettuja kaupan toimintoja, jotka on määritetty kohteessa script.js.

Vuorovaikutteisten komponenttien rakentaminen

Täydellisiä esimerkkejä haitarivalikoista, välilehdistä, modaali-ikkunoista ja tykkäyspainikkeista.