İçeriğe geç

Etkileşimlilik

Blockstudio, bloklarınıza duyarlı, istemci tarafında davranış eklemek için standart bir yöntem sunan EtkileşimlilikWordPressAPI öğesini destekler. interactivity değerini block.json içinde ayarlayın; Blockstudio ise API öğesinin hem ön yüzde hem de düzenleyicide yüklenmesini sağlar.

Yapılandırma

block.json içindeki blockstudio anahtarına interactivity ekleyerek Etkileşimlilik API özelliğini etkinleştirin:

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

Nesne biçimini de kullanabilirsiniz:

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

Her iki biçim de eşdeğerdir.

Şablon

Blok şablonunuza Etkileşimlilik API yönergelerini ekleyin. data-wp-interactive özniteliği mağaza ad alanını tanımlar; diğer data-wp-* öznitelikleri ise duyarlı davranışı denetler.

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>

Betik

Blok klasörünüzde script.js dosyası oluşturun; bu dosya @wordpress/interactivity öğesinden içe aktarma yapıp mağazanızı başlatır. Modülün en üst düzeyinde store() çağrısını yapın:

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

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

Blockstudio, script.js öğesini bir ES modülü olarak yükler ve @wordpress/interactivity öğesinin çözümlenmesi için gereken importmap’i otomatik olarak oluşturur.

Bloğunuz özel eylemler veya geri çağırmalar tanımlıyorsa script.js gerekir. Yalnızca data-wp-context ile bildirim temelli yönergeler kullanan (data-wp-bind--hidden veya data-wp-text gibi) bloklar JavaScript olmadan çalışır.

Sunucu Tarafı Durumu

Durumu PHP üzerinden başlatmak için şablonunuzda wp_interactivity_state() kullanabilirsiniz:

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>

Sunucu tarafı durumu yalnızca ön yüzde kullanılabilir. WordPress, durumu sayfa çıktısındaki bir JSON script etiketine serileştirir; Interactivity API, hidratasyon sırasında bunu okur. Düzenleyicide bloklar REST API üzerinden işlenir, bu nedenle durum verileri yanıta eklenmez. Hem düzenleyicide hem ön yüzde çalışması gereken durumlar için data-wp-context kullanın.

Geri Çağırmalar ve Eylemler

Eylemler kullanıcı etkileşimleriyle (data-wp-on--click gibi) tetiklenir. Geri çağırmalar, data-wp-watch yönergesini kullanarak durum veya bağlam değiştiğinde tepkisel olarak tetiklenir. Geri çağırmaların içinde, temel DOM öğesine erişmek için getElement() çağırabilirsiniz:

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

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

Düzenleyici Desteği

Interactivity API, blok düzenleyici iframe’inin içinde yüklenir; bu nedenle etkileşimli yönergeler düzenleyici önizlemelerinde çalışır. Buna data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text ve script.js içinde tanımlanan özel mağaza eylemleri dahildir.

Etkileşimli Bileşenler Oluşturma

Akordeonlar, sekmeler, modal pencereler ve beğeni düğmeleri içeren eksiksiz örnekler.