Hoppa till innehåll

useBlockProps

Som standard måste Gutenberg skapa en omslutning runt block för att göra dem interaktiva i redigeraren. Det kan vara problematiskt för vissa blocktyper, till exempel behållare eller kolumner, eftersom markupen skiljer sig mellan redigeraren och frontend. Kroken useBlockProps gör det möjligt att markera ett element i blockmallen som rotelement och därmed skapa samma markup i redigeraren och frontend.

Användning

Lägg helt enkelt till attributet useBlockProps i rotelementet för ditt block.

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

Blockstudio kombinerar automatiskt klasser och attribut från redigeraren (justeringsklasser osv.) med det som har definierats i blockmallarna. get_block_wrapper_attributes används internt för detta.

Filtret blockstudio/blocks/components/use_block_props/render tillämpas på omslutningen i både frontendens och redigerarens återgivningsvägar. Klasser som läggs till av ett tema eller en integration för en enskild instans visas därför både på redigerarens arbetsyta och i den sparade markupen i frontend.

Utdata:

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

Att tänka på

Blockstudio förhindrar länknavigering i blockredigeraren, inklusive target="_blank", klick med modifierartangent, mittenklick och aktivering med tangentbordet. Klickhändelser når fortfarande Gutenberg, så vanliga klick väljer blocket. RichText går fortfarande att redigera. Detta gäller med eller utan useBlockProps, även när ett ankare används som blockets rotelement.

Länkar i frontend och webbläsarens kommandon på snabbmenyn fungerar som förut. Du behöver inte ta bort länkar från mallar eller villkorsgrena på $isEditor.

Rotelement

Eftersom det bara kan finnas ett rotelement i en blockmall måste blockmallen ha ett enda rotelement när useBlockProps används. Följande exempel fungerar till exempel inte, och Gutenberg skapar en omslutning runt mallen.

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

På samma sätt kan useBlockProps bara användas en gång per blockmall.

@-tecknet

Blockstudio omvandlar blockmallen till giltig kod i React inuti Gutenberg med hjälp av html-react-parser. Det innebär att tecknet @ inte kan användas i ett attributnamn för HTML.

Bibliotek som Alpine.js använder tecknet @ för att definiera direktiv på element av typen HTML.

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

Inuti Gutenberg tas attributet @click bort från elementet. (Det fungerar fortfarande i frontend, förstås.)

För att lösa problemet kan du använda den alternativa syntaxen som Alpine.js tillhandahåller.

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

Ovanstående fungerar både inuti Gutenberg och i frontend.

Klasser på arbetsytans body

När assets.reset.enabled är aktiv kopierar Blockstudio även de sanerade klasserna som returneras av filtret WordPresss body_class till blockredigerarens arbetsyta. Det gör att temaväljare som .brand-a .site-card fungerar på båda ställen.

Filtrera den slutliga klasslistan när redigeraren behöver ett snävare urval:

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

Det här filtret styr endast vilka klasser som kopieras till redigerarens arbetsyta. Det ändrar inte body-klasserna i frontend.