Interaktyvumas
Blockstudio palaiko WordPress Interactivity API, kuris suteikia standartinį būdą pridėti reaktyvų veikimą kliento pusėje prie jūsų blokų. Nustatykite interactivity savo block.json, o Blockstudio pasirūpins API įkėlimu tiek frontend puslapyje, tiek redaktoriuje.
Konfigūracija
Įjunkite Interactivity API pridėdami interactivity prie rakto blockstudio faile block.json:
{
"name": "my-theme/interactive-block",
"title": "Interactive Block",
"category": "text",
"icon": "star-filled",
"description": "A block with interactive behavior.",
"blockstudio": {
"interactivity": true
}
}
Taip pat galite naudoti objekto formą:
{
"blockstudio": {
"interactivity": {
"enqueue": true
}
}
}
Abi formos yra lygiavertės.
Šablonas
Pridėkite Interactivity API direktyvas prie savo bloko šablono. Atributas data-wp-interactive apibrėžia saugyklos vardų sritį, o kiti data-wp-* atributai valdo reaktyvų veikimą.
<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>
Scenarijus
Bloko aplanke sukurkite failą script.js, importuokite iš @wordpress/interactivity ir inicijuokite saugyklą. Iškvieskite store() aukščiausiame modulio lygmenyje:
import { store, getContext } from '@wordpress/interactivity';
store('myBlock', {
actions: {
toggle: () => {
const context = getContext();
context.isOpen = !context.isOpen;
},
},
});
Blockstudio įkelia script.js kaip ES modulį ir automatiškai sugeneruoja importų žemėlapį, reikalingą @wordpress/interactivity nustatyti.
script.js reikalinga tik tuo atveju, jei jūsų blokas apibrėžia pasirinktinius veiksmus arba atgalinio iškvietimo funkcijas. Blokai, kuriuose naudojamos tik deklaratyvios direktyvos su data-wp-context (pvz., data-wp-bind--hidden arba data-wp-text), veikia be jokios JavaScript.
Būsena serverio pusėje
Galite naudoti wp_interactivity_state() šablone būsenai iš PHP inicijuoti:
<?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>
Būsena serverio pusėje pasiekiama tik sąsajoje. WordPress serializuoja būseną į JSON scenarijaus žymą puslapio išvestyje, kurią „Interactivity“ API nuskaito hidratuojant. Redaktoriuje blokai atvaizduojami per REST API, todėl būsenos duomenys į atsakymą neįtraukiami. Būsenai, kuri turi veikti ir redaktoriuje, ir sąsajoje, naudokite data-wp-context.
Atgalinio iškvietimo funkcijos ir veiksmai
Veiksmai sužadinami naudotojui sąveikaujant (pvz., data-wp-on--click). Atgalinio iškvietimo funkcijos sužadinamos reaguojant į būsenos arba konteksto pokyčius, naudojant direktyvą data-wp-watch. Atgalinio iškvietimo funkcijose galite iškviesti getElement(), kad pasiektumėte pagrindinį DOM elementą:
import { store, getContext, getElement } from '@wordpress/interactivity';
store('myBlock', {
callbacks: {
updateWidth: () => {
const { ref } = getElement();
const { isOpen } = getContext();
ref.style.width = isOpen ? '100%' : '0';
},
},
});
Palaikymas redaktoriuje
„Interactivity“ API įkeliamas bloko redaktoriaus iframe, todėl interaktyvios direktyvos veikia redaktoriaus peržiūrose. Tai apima data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text ir pasirinktinius saugyklos veiksmus, apibrėžtus script.js.
Interaktyvių komponentų kūrimas
Išsamūs pavyzdžiai su išskleidžiamaisiais skydeliais, skirtukais, modaliaisiais langais ir mygtukais „Patinka“.