Pular para o conteúdo

Interatividade

Blockstudio oferece suporte à WordPress Interactivity API, que fornece uma maneira padrão de adicionar comportamento reativo no lado do cliente aos seus blocos. Defina interactivity no seu block.json, e Blockstudio cuida do carregamento de API tanto no frontend quanto no editor.

Configuração

Ative o Interactivity API adicionando interactivity à chave blockstudio no seu 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
  }
}

Você também pode usar o formato de objeto:

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

As duas formas são equivalentes.

Modelo

Adicione diretivas de Interactivity API ao modelo do bloco. O atributo data-wp-interactive define o namespace do store, e outros atributos data-wp-* controlam o comportamento reativo.

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>

Script

Crie um arquivo script.js na pasta do bloco que importe de @wordpress/interactivity e inicialize o seu store. Chame store() no nível superior do módulo:

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

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

Blockstudio carrega script.js como um módulo ES e gera automaticamente o importmap necessário para resolver @wordpress/interactivity.

Um script.js só é necessário se o seu bloco definir ações ou callbacks personalizados. Blocos que usam apenas diretivas declarativas com data-wp-context (como data-wp-bind--hidden ou data-wp-text) funcionam sem JavaScript.

Estado no servidor

Você pode usar wp_interactivity_state() no seu template para inicializar o estado a partir de 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>

O estado no servidor só fica disponível no frontend. WordPress serializa o estado em uma tag de script JSON na saída da página, que a API de Interactivity lê durante a hidratação. No editor, os blocos são renderizados pela REST API, então os dados de estado não são incluídos na resposta. Use data-wp-context para estados que precisam funcionar tanto no editor quanto no frontend.

Callbacks e ações

As ações são acionadas por interações do usuário (como data-wp-on--click). Os callbacks são acionados de forma reativa quando o estado ou o contexto muda, usando a diretiva data-wp-watch. Dentro dos callbacks, você pode chamar getElement() para acessar o elemento DOM subjacente:

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

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

Suporte ao editor

A API de Interactivity é carregada dentro do iframe do editor de blocos, então as diretivas interativas funcionam nas prévias do editor. Isso inclui data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text e ações personalizadas da store definidas em script.js.

Como criar componentes interativos

Exemplos completos com acordeões, abas, modais e botões de curtida.