Siirry sisältöön

useBlockProps

Oletuksena Gutenberg luo lohkojen ympärille kääreen, jotta ne toimivat vuorovaikutteisesti editorissa. Tämä voi olla ongelmallista tietyille lohkotyypeille, kuten säilöille ja palstoille, koska editorin ja julkisen sivun merkintä eroaa toisistaan. useBlockProps-koukun avulla lohkomallin elementin voi määrittää juurielementiksi, jolloin merkintä on sama editorissa ja julkisella sivulla.

Käyttö

Lisää yksinkertaisesti useBlockProps-attribuutti lohkosi juurielementtiin.

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

Blockstudio yhdistää automaattisesti editorin luokat ja attribuutit (kuten tasausluokat) lohkomalleissa määriteltyihin tietoihin. Tähän käytetään taustalla toimintoa get_block_wrapper_attributes.

Suodatinta blockstudio/blocks/components/use_block_props/render käytetään kääreeseen sekä julkisen sivun että editorin renderöintipoluilla. Teeman tai lohkoesimerkkiin liitetyn integraation lisäämät luokat näkyvät siis editorin piirtoalueella ja tallennetussa julkisen sivun merkinnässä.

Tuloste:

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

Huomioitavaa

Blockstudio estää linkkien avaamisen lohkoeditorissa, myös target="_blank"-, muunnosnäppäimillä tehdyt ja keskipainikkeen napsautukset sekä näppäimistöllä aktivoinnin. Napsautustapahtumat välittyvät silti Gutenberg-elementille, joten tavalliset napsautukset valitsevat lohkon. RichText pysyy muokattavana. Tämä koskee käyttöä sekä useBlockProps kanssa että ilman sitä, myös silloin, kun ankkuri on lohkon juurielementti.

Käyttöliittymän linkit ja selaimen pikavalikon komennot pysyvät ennallaan. Linkkejä ei tarvitse poistaa malleista eikä $isEditor-tilaa tarvitse tarkistaa ehtolauseella.

Juurielementti

Koska lohkomallissa voi olla vain yksi juurielementti, mallissa on oltava yksi juurielementti, kun käytät ominaisuutta useBlockProps. Esimerkiksi seuraava ei toimi, ja Gutenberg luo mallin ympärille kääreen.

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

useBlockProps-toimintoa voi vastaavasti käyttää vain kerran kussakin lohkomallissa.

@-merkki

Blockstudio muuntaa lohkomallin kelvolliseksi React-koodiksi Gutenberg-ympäristössä käyttämällä html-react-parser-kirjastoa. Tästä seuraa rajoitus: merkkiä @ ei voi käyttää HTML-attribuutin nimessä.

Kirjastot, kuten Alpine.js, käyttävät merkkejä @ määrittämään direktiivejä elementeille HTML.

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

Komponentin Gutenberg sisällä tämä attribuutti @click poistetaan elementistä. (Se toimii silti julkisella sivulla, tietenkin.)

Voit ratkaista tämän ongelman käyttämällä vaihtoehtoista syntaksia, jonka Alpine.js tarjoaa.

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

Yllä oleva toimii komponentin Gutenberg sisällä ja julkisella sivulla.

Piirtoalueen body-luokat

Kun assets.reset.enabled on käytössä, Blockstudio kopioi myös WordPressn body_class-suodattimen palauttamat siivotut luokat lohkoeditorin piirtoalueelle. Näin teeman valitsimet, kuten .brand-a .site-card, toimivat molemmissa paikoissa.

Suodata lopullinen luettelo, jos editorissa tarvitaan suppeampi joukko:

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

Tämä suodatin hallitsee vain editorin piirtoalueelle kopioitavia luokkia. Se ei muuta julkisen sivun body-luokkia.