Treci la conținut

useBlockProps

În mod implicit, Gutenberg trebuie să creeze un înveliș în jurul blocurilor pentru a le face interactive în editor. Acest lucru poate fi problematic pentru unele tipuri de blocuri, precum containerele sau coloanele, deoarece marcajul diferă între editor și frontend. Hook-ul useBlockProps vă permite să marcați un element din șablonul blocului drept element rădăcină, asigurând astfel paritatea marcajului între editor și frontend.

Utilizare

Adăugați pur și simplu atributul useBlockProps la elementul rădăcină al blocului.

PHP
<div useBlockProps class="my-class">
  <!--
  This element will be rendered
  as the root element of your block
  in Gutenberg.
  -->
</div>

Blockstudio va combina automat clasele și atributele din editor (clase de aliniere etc.) cu cele definite în șabloanele blocurilor. În acest scop, se folosește intern get_block_wrapper_attributes.

Filtrul blockstudio/blocks/components/use_block_props/render se aplică învelișului atât la randarea în frontend, cât și în editor. Prin urmare, clasele adăugate de o temă sau de o integrare per instanță apar atât pe pânza editorului, cât și în marcajul salvat pentru frontend.

Rezultat:

HTML
<div class="my-class wp-block-your-block-name alignright">
</div>

Aspecte de luat în considerare

Blockstudio împiedică navigarea prin linkuri în editorul de blocuri, inclusiv target="_blank", clicurile cu modificatori, clicurile cu butonul din mijloc și activarea de la tastatură. Evenimentele de clic ajung în continuare la Gutenberg, astfel încât clicurile obișnuite selectează blocul. RichText rămâne editabil. Acest lucru se aplică cu sau fără useBlockProps, inclusiv când un element anchor este elementul rădăcină al blocului.

Linkurile din interfața publică și comenzile meniului contextual al browserului rămân neschimbate. Nu trebuie să eliminați linkurile din șabloane sau să folosiți condiții în funcție de $isEditor.

Elementul rădăcină

Deoarece într-un șablon de bloc poate exista un singur element rădăcină, când folosiți useBlockProps, șablonul blocului trebuie să aibă un singur element rădăcină. De exemplu, următorul caz nu va funcționa, iar Gutenberg va crea un înveliș în jurul șablonului.

PHP
<div useBlockProps>
  First root element.
</div>
<span>
  Second root element.
</span>

În mod similar, useBlockProps poate fi folosit o singură dată în fiecare șablon de bloc.

Semnul @

Blockstudio convertește șablonul blocului în cod React valid în Gutenberg folosind html-react-parser. Aceasta impune limitarea că nu se poate folosi caracterul @ într-un nume de atribut HTML.

Biblioteci precum Alpine.js folosesc caracterele @ pentru a defini directive pe elementele HTML.

PHP
<button useBlockProps @click="console.log('hi')">
  Click me
</button>

În Gutenberg, acest atribut @click va fi eliminat din element. (Desigur, va funcționa în continuare în frontend.)

Pentru a evita această problemă, puteți folosi sintaxa alternativă oferită de Alpine.js.

PHP
<button useBlockProps x-on:click="console.log('hi')">
  Click me
</button>

Cele de mai sus vor funcționa în Gutenberg și în frontend.

Clasele corpului pânzei

Când assets.reset.enabled este activ, Blockstudio copiază și clasele sanitizate returnate de filtrul body_class al WordPress în pânza editorului. Astfel, selectori ai temei precum .brand-a .site-card funcționează în ambele locuri.

Filtrați lista finală de clase când editorul are nevoie de un set mai restrâns:

PHP
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
  return array_values(array_diff($classes, ['logged-in']));
});

Acest filtru controlează doar clasele copiate în pânza editorului. Nu modifică clasele body din frontend.