Přejít k obsahu

useBlockProps

Ve výchozím nastavení musí Gutenberg vytvořit kolem bloků obal, aby byly v editoru interaktivní. To může způsobovat problémy u některých typů bloků, například kontejnerů nebo sloupců, protože struktura značek se bude v editoru a na frontendu lišit. Hook useBlockProps umožňuje v šabloně bloku označit prvek jako kořenový, a zajistit tak shodnou strukturu značek v editoru i na frontendu.

Použití

Stačí přidat atribut useBlockProps ke kořenovému prvku bloku.

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

Blockstudio automaticky zkombinuje třídy a atributy z editoru (například třídy zarovnání) s těmi, které jsou definovány v šablonách bloků. K tomu se na pozadí používá get_block_wrapper_attributes.

Filtr blockstudio/blocks/components/use_block_props/render se aplikuje na obal při vykreslování na frontendu i v editoru. Třídy přidané motivem nebo integrací pro konkrétní instanci se proto zobrazí v plátně editoru i v uložených značkách na frontendu.

Výstup:

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

Důležité informace

Blockstudio zabraňuje navigaci po odkazech uvnitř editoru bloků, včetně target="_blank", kliknutí se stisknutou modifikační klávesou, kliknutí prostředním tlačítkem a aktivace z klávesnice. Události kliknutí se stále předávají Gutenberg, takže běžné kliknutí vybere blok. RichText zůstává upravitelný. Platí to s useBlockProps i bez něj, včetně odkazu použitého jako kořenový prvek bloku.

Odkazy na frontendu a příkazy v kontextové nabídce prohlížeče zůstávají beze změny. Odkazy ze šablon nemusíte odstraňovat ani větvit podle $isEditor.

Kořenový prvek

Protože šablona bloku může mít pouze jeden kořenový prvek, musí mít při použití useBlockProps jediný kořenový prvek. Následující příklad proto nebude fungovat a Gutenberg vytvoří kolem šablony obal.

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

useBlockProps lze podobně použít pouze jednou v každé šabloně bloku.

Znak @

Blockstudio převádí šablonu bloku na platný kód React uvnitř Gutenberg pomocí html-react-parser. S tím souvisí omezení: znak @ nelze použít v názvu atributu HTML.

Knihovny jako Alpine.js používají znaky @ k definování direktiv v prvcích HTML.

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

Uvnitř Gutenberg bude tento atribut @click z prvku odstraněn. (Na frontendu bude samozřejmě stále fungovat.)

Tomuto problému lze předejít použitím alternativní syntaxe, kterou nabízí Alpine.js.

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

Výše uvedený příklad bude fungovat uvnitř Gutenberg i na frontendu.

Třídy těla plátna editoru

Když je aktivní assets.reset.enabled, Blockstudio také kopíruje do plátna editoru očištěné třídy, které vrací filtr body_class v WordPress. Díky tomu v editoru i na frontendu fungují selektory motivu, například .brand-a .site-card.

Pokud editor potřebuje užší sadu, filtrujte konečný seznam tříd:

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

Tento filtr ovlivňuje pouze třídy kopírované do plátna editoru. Třídy body na frontendu nemění.