Liigu sisu juurde

Interaktiivsus

Blockstudio toetab WordPress interaktiivsuse API, mis pakub standardset viisi reaktiivse käitumise lisamiseks plokkidesse kliendi poolel. Määrake interactivity oma block.json-is ning Blockstudio hoolitseb API laadimise eest nii saidi kasutajaliideses kui ka redaktoris.

Konfiguratsioon

Lubage interaktiivsuse API, lisades interactivity võtmele blockstudio oma failis 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
  }
}

Võite kasutada ka objekti vormi:

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

Mõlemad vormid on samaväärsed.

Mall

Lisage ploki mallile interaktiivsuse API direktiivid. Atribuut data-wp-interactive määrab poe nimeruumi ja teised data-wp-* atribuudid juhivad reaktiivset käitumist.

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

Looge ploki kausta fail script.js, mis impordib moodulist @wordpress/interactivity ja lähtestab teie poe. Kutsuge mooduli tipptasemel välja store():

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

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

Blockstudio laadib script.js ES-moodulina ja loob automaatselt impordikaardi, mis on vajalik @wordpress/interactivity lahendamiseks.

script.js on vajalik ainult siis, kui sinu plokk määratleb kohandatud toiminguid või tagasihelistusi. Plokid, mis kasutavad ainult deklaratiivseid direktiive koos data-wp-context-ga (näiteks data-wp-bind--hidden või data-wp-text), töötavad ilma JavaScript-ta.

Serveripoolne olek

Saad kasutada mallis wp_interactivity_state()-i, et lähtestada olek väärtusest 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>

Serveripoolne olek on saadaval ainult esiküljel. WordPress serialiseerib oleku lehe väljundis olevasse JSON skriptisildi sisse, mida Interactivity API loeb hüdratsiooni ajal. Redaktoris renderdatakse plokke REST API abil, mistõttu olekuandmeid vastusesse ei lisata. Kasuta data-wp-context-i oleku jaoks, mis peab toimima nii redaktoris kui ka esiküljel.

Tagasihelistused ja toimingud

Toimingud käivituvad kasutaja interaktsioonide (näiteks data-wp-on--click) peale. Tagasihelistused käivituvad reaktiivselt, kui olek või kontekst muutub, kasutades direktiivi data-wp-watch. Tagasihelistuse sees saad kasutada getElement()-i aluseks oleva DOM-elemendi leidmiseks:

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

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

Redaktori tugi

Interactivity API laaditakse plokiredaktori iframe’i sisse, nii et interaktiivsed direktiivid toimivad redaktori eelvaadetes. See hõlmab data-wp-context-i, data-wp-bind--*-i, data-wp-on--*-i, data-wp-text-i ja kohandatud poe toiminguid, mis on määratletud script.js-is.

Interaktiivsete komponentide loomine

Täielikud näited akordionide, sakkide, modaalide ja meeldimisnuppudega.