Pāriet uz saturu

Interaktivitāte

Blockstudio atbalsta WordPress Interactivity API, kas nodrošina standarta veidu, kā blokiem pievienot reaktīvu darbību klienta pusē. Iestatiet interactivity savā block.json, un Blockstudio parūpēsies par API ielādi gan priekšgalā, gan redaktorā.

Konfigurācija

Iespējojiet Interactivity API, pievienojot interactivity atslēgai blockstudio savā 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
  }
}

Varat izmantot arī objekta formu:

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

Abas formas ir līdzvērtīgas.

Veidne

Pievienojiet Interactivity API direktīvas savai bloka veidnei. Atribūts data-wp-interactive definē krātuves nosaukumvietu, bet citi data-wp-* atribūti kontrolē reaktīvo darbību.

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>

Skripts

Izveidojiet failu script.js sava bloka mapē, importējiet tajā no @wordpress/interactivity un inicializējiet savu krātuvi. Izsauciet store() moduļa augšējā līmenī:

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

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

Blockstudio ielādē script.js kā ES moduli un automātiski ģenerē importmap, kas nepieciešama, lai atrisinātu @wordpress/interactivity.

script.js ir vajadzīgs tikai tad, ja jūsu blokā ir definētas pielāgotas darbības vai atzvanīšanas funkcijas. Bloki, kuros izmantotas tikai deklaratīvas direktīvas ar data-wp-context (piemēram, data-wp-bind--hidden vai data-wp-text), darbojas bez JavaScript.

Servera puses stāvoklis

Varat izmantot wp_interactivity_state() savā veidnē, lai inicializētu stāvokli no 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>

Servera puses stāvoklis ir pieejams tikai priekšgalā. WordPress serializē stāvokli JSON skripta tagā lapas izvadē, ko Interactivity API nolasa hidratācijas laikā. Redaktorā bloki tiek renderēti, izmantojot REST API, tāpēc atbildē nav iekļauti stāvokļa dati. Izmantojiet data-wp-context stāvoklim, kam jādarbojas gan redaktorā, gan priekšgalā.

Atzvanīšanas funkcijas un darbības

Darbības tiek aktivizētas lietotāja mijiedarbības rezultātā (piemēram, data-wp-on--click). Atzvanīšanas funkcijas tiek aktivizētas reaktīvi, mainoties stāvoklim vai kontekstam, izmantojot direktīvu data-wp-watch. Atzvanīšanas funkcijās varat izsaukt getElement(), lai piekļūtu pamatā esošajam DOM elementam:

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

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

Atbalsts redaktorā

Interactivity API tiek ielādēts bloku redaktora iframe, tāpēc interaktīvās direktīvas darbojas redaktora priekšskatījumos. Tas ietver data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text un pielāgotas veikala darbības, kas definētas script.js.

Interaktīvu komponentu veidošana

Pilni piemēri ar akordeoniem, cilnēm, modālajiem logiem un atzīmēšanas pogām.