Preskočiť na obsah

useBlockProps

V predvolenom nastavení musí Gutenberg vytvoriť obal okolo blokov, aby boli v editore interaktívne. Pri niektorých typoch blokov, ako sú kontajnery alebo stĺpce, to môže byť problematické, pretože sa ich štruktúra značiek v editore a na frontende líši. Pomocou hooku useBlockProps možno označiť prvok v šablóne bloku ako koreňový prvok, čím sa zabezpečí zhodná štruktúra značiek v editore aj na frontende.

Použitie

Stačí pridať atribút useBlockProps ku koreňové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 skombinuje triedy a atribúty z editora (napríklad triedy zarovnania) s tými, ktoré sú definované v šablónach blokov. Na tento účel sa interne používa get_block_wrapper_attributes.

Filter blockstudio/blocks/components/use_block_props/render sa použije na obal pri vykresľovaní na frontende aj v editore. Triedy pridané témou alebo integráciou konkrétnej inštancie sa preto zobrazia na plátne editora aj v uložených značkách na frontende.

Výstup:

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

Čo treba zvážiť

Blockstudio zabraňuje navigácii pomocou odkazov v editore blokov vrátane target="_blank", kliknutí s modifikačnými klávesmi, kliknutí stredným tlačidlom a aktivácie klávesnicou. Udalosti kliknutia sa naďalej dostávajú k Gutenberg, takže bežné kliknutia vyberú blok. RichText zostáva upraviteľný. Platí to s useBlockProps aj bez neho, vrátane prípadu, keď je koreňovým prvkom bloku kotva.

Odkazy na webovej stránke a príkazy kontextovej ponuky prehliadača zostávajú nezmenené. Odkazy zo šablón nemusíte odstraňovať ani podmieňovať podľa $isEditor.

Koreňový prvok

Keďže šablóna bloku môže mať iba jeden koreňový prvok, pri použití useBlockProps musí obsahovať jeden koreňový prvok. Nasledujúci príklad preto nebude fungovať a Gutenberg vytvorí okolo šablóny obal.

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

Podobne možno useBlockProps použiť v šablóne bloku iba raz.

Znak @

Blockstudio prevádza šablónu bloku na platný kód React v rámci Gutenberg pomocou html-react-parser. Z toho vyplýva, že znak @ nemožno použiť v názve atribútu HTML.

Knižnice ako Alpine.js používajú znaky @ na definovanie direktív v prvkoch HTML.

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

V rámci Gutenberg sa tento atribút @click z prvku odstráni. (Na frontende, samozrejme, bude naďalej fungovať.)

Tento problém môžete obísť použitím alternatívnej syntaxe, ktorú poskytuje Alpine.js.

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

Uvedený príklad bude fungovať v rámci Gutenberg aj na frontende.

Triedy tela na plátne editora

Keď je assets.reset.enabled aktívne, Blockstudio skopíruje na plátno editora aj očistené triedy, ktoré vracia filter body_class v rámci WordPress. Vďaka tomu fungujú selektory témy, ako napríklad .brand-a .site-card, na oboch miestach.

Ak editor potrebuje užší výber tried, použite filter konečného zoznamu tried:

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

Tento filter ovplyvňuje iba triedy skopírované na plátno editora. Triedy tela na frontende nemení.