Przejdź do treści

useBlockProps

Domyślnie Gutenberg musi utworzyć kontener wokół bloków, aby umożliwić interakcję z nimi w edytorze. Może to być problematyczne w przypadku niektórych typów bloków, takich jak kontenery i kolumny, ponieważ znaczniki w edytorze będą się różnić od tych w interfejsie witryny. Hook useBlockProps umożliwia wskazanie elementu w szablonie bloku jako elementu głównego, zapewniając zgodność znaczników w edytorze i interfejsie witryny.

Użycie

Po prostu dodaj atrybut useBlockProps do elementu głównego bloku.

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

Blockstudio automatycznie połączy klasy i atrybuty z edytora (np. klasy wyrównania) z tymi zdefiniowanymi w szablonach bloków. W tym celu wewnętrznie używany jest get_block_wrapper_attributes.

Filtr blockstudio/blocks/components/use_block_props/render jest stosowany do kontenera zarówno podczas renderowania w interfejsie witryny, jak i w edytorze. Dlatego klasy dodane przez motyw lub integrację dla konkretnej instancji pojawiają się zarówno na obszarze roboczym edytora, jak i w zapisanych znacznikach interfejsu witryny.

Wynik:

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

Uwagi

Blockstudio blokuje nawigację za pomocą linków w edytorze bloków, w tym target="_blank", kliknięcia z klawiszem modyfikującym, kliknięcia środkowym przyciskiem i aktywację z klawiatury. Zdarzenia kliknięcia nadal docierają do Gutenberg, więc zwykłe kliknięcia zaznaczają blok. RichText pozostaje edytowalny. Dotyczy to sytuacji z useBlockProps i bez niego, w tym kotwicy użytej jako element główny bloku.

Linki w interfejsie witryny i polecenia menu kontekstowego przeglądarki działają bez zmian. Nie musisz usuwać linków z szablonów ani rozgałęziać logiki na podstawie $isEditor.

Element główny

Ponieważ szablon bloku może mieć tylko jeden element główny, przy użyciu useBlockProps musi zawierać dokładnie jeden taki element. Na przykład poniższe rozwiązanie nie zadziała, a Gutenberg utworzy kontener wokół szablonu.

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

Podobnie useBlockProps można użyć tylko raz w każdym szablonie bloku.

Znak @

Blockstudio konwertuje szablon bloku na prawidłowy kod React w Gutenberg za pomocą html-react-parser. Ograniczeniem jest to, że znaku @ nie można używać w nazwie atrybutu HTML.

Biblioteki takie jak Alpine.js używają znaków @ do definiowania dyrektyw na elementach HTML.

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

W Gutenberg atrybut @click zostanie usunięty z elementu. (Oczywiście nadal będzie działać w interfejsie witryny).

Aby rozwiązać ten problem, możesz użyć alternatywnej składni udostępnianej przez Alpine.js.

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

Powyższe rozwiązanie będzie działać w Gutenberg i w interfejsie witryny.

Klasy treści obszaru roboczego

Gdy assets.reset.enabled jest aktywne, Blockstudio kopiuje również oczyszczone klasy zwracane przez filtr body_class obiektu WordPress do obszaru roboczego edytora. Dzięki temu selektory motywu, takie jak .brand-a .site-card, działają w obu miejscach.

Użyj tego filtra, aby ograniczyć listę klas kopiowanych do edytora:

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

Ten filtr steruje tylko klasami kopiowanymi do obszaru roboczego edytora. Nie zmienia klas body w interfejsie witryny.