Lewati ke konten

Interaktivitas

Blockstudio mendukung WordPress Interactivity API, yang menyediakan cara standar untuk menambahkan perilaku reaktif di sisi klien ke blok Anda. Atur interactivity di block.json Anda, lalu Blockstudio menangani pemuatan API di frontend dan editor.

Konfigurasi

Aktifkan API Interactivity dengan menambahkan interactivity ke kunci blockstudio di block.json Anda:

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

Anda juga dapat menggunakan bentuk objek:

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

Kedua bentuk tersebut setara.

Templat

Tambahkan direktif Interactivity API ke templat blok Anda. Atribut data-wp-interactive menentukan namespace store, sedangkan atribut data-wp-* lainnya mengontrol perilaku reaktif.

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>

Skrip

Buat file script.js di folder blok Anda yang mengimpor dari @wordpress/interactivity dan menginisialisasi store Anda. Panggil store() di tingkat teratas modul:

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

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

Blockstudio memuat script.js sebagai modul ES dan secara otomatis membuat importmap yang diperlukan untuk me-resolve @wordpress/interactivity.

script.js hanya diperlukan jika blok Anda mendefinisikan tindakan atau callback khusus. Blok yang hanya menggunakan direktif deklaratif dengan data-wp-context (seperti data-wp-bind--hidden atau data-wp-text) dapat berfungsi tanpa JavaScript.

Status Sisi Server

Anda dapat menggunakan wp_interactivity_state() di templat untuk menginisialisasi status dari 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>

Status sisi server hanya tersedia di frontend. WordPress menserialisasi status ke dalam tag skrip JSON pada keluaran halaman, yang dibaca oleh API Interactivity saat hidrasi. Di editor, blok dirender melalui REST API, sehingga data status tidak disertakan dalam respons. Gunakan data-wp-context untuk status yang perlu berfungsi di editor dan frontend.

Callback vs. Tindakan

Tindakan dipicu oleh interaksi pengguna (seperti data-wp-on--click). Callback dipicu secara reaktif saat status atau konteks berubah, menggunakan direktif data-wp-watch. Di dalam callback, Anda dapat memanggil getElement() untuk mengakses elemen DOM yang mendasarinya:

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

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

Dukungan Editor

Interactivity API dimuat di dalam iframe editor blok, sehingga direktif interaktif berfungsi di pratinjau editor. Ini mencakup data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text, dan tindakan store khusus yang didefinisikan di script.js.

Membangun Komponen Interaktif

Contoh lengkap dengan akordeon, tab, modal, dan tombol suka.