Ga naar de inhoud

RichText

Wijzigingen in RichText worden direct opgeslagen in de attributen van het blok en maken deel uit van de geschiedenis voor ongedaan maken en opnieuw uitvoeren van Gutenberg, ook voor RichText in herhaalrijen. Als je opslaat terwijl meerdere blokken zijn geselecteerd, behoudt elk blok zijn eigen inhoud en attributen.

Met de component RichText kun je een bewerkbaar invoerveld in de editor renderen en een statisch element HTML aan de frontend. Deze is gebaseerd op de component RichText die WordPress aanbiedt.

Basisgebruik

Om RichText in de eenvoudigste vorm te gebruiken, moet je het juiste attribuut toevoegen aan je block.json en de component RichText aan je blok toevoegen.

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "blockstudio/rich-text",
  "title": "Native Block",
  "category": "text",
  "icon": "star-filled",
  "description": "Native Blockstudio RichText block.",
  "blockstudio": {
    "attributes": [
      {
        "id": "myRichText",
        "type": "richtext"
      }
    ]
  }
}
PHP
<RichText attribute="myRichText" />

Je kunt een onbeperkt aantal RichText-componenten in je blok gebruiken.

Eigenschappen

allowedFormats

Je kunt de indelingen beperken die in de RichText-component kunnen worden gebruikt met de prop allowedFormats.

PHP

PHP
<RichText attribute="myRichText" allowedFormats="<?php echo esc_attr(wp_json_encode(['core/bold', 'core/italic'])); ?>" />

Twig

Twig
<RichText attribute="myRichText" allowedFormats="{{ ['core/bold', 'core/italic']|json_encode|escape('html_attr') }}" />

Tijdelijke aanduiding

Je kunt een tijdelijke aanduiding instellen voor de RichText-component met de prop placeholder.

PHP
<RichText attribute="myRichText" placeholder="Enter some text" />

preserveWhiteSpace

Of witruimtetekens in de waarde behouden moeten blijven. Normaal gesproken worden tabs, regeleinden en spaties samengevoegd tot één spatie. Als deze optie is ingeschakeld, worden zachte regeleinden opgeslagen als newline-tekens in plaats van als regeleindeelementen.

PHP
<RichText attribute="myRichText" preserveWhiteSpace="true" />

tag

Standaard wordt de inhoud van RichText weergegeven in een element p. Je kunt dit wijzigen met de prop tag.

PHP
<RichText attribute="myRichText" tag="h1" />

withoutInteractiveFormatting

Standaard zijn alle opmaakbedieningselementen aanwezig. Met deze instelling kun je opmaakbedieningselementen verwijderen die de inhoud interactief zouden maken.

PHP
<RichText attribute="myRichText" withoutInteractiveFormatting="true" />

Herhaalvelden

RichText werkt binnen herhaalvelden. Gebruik de notatie met vierkante haken en de lusindex om de juiste rij te selecteren.

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "items",
        "type": "repeater",
        "attributes": [
          {
            "id": "heading",
            "type": "richtext"
          }
        ]
      }
    ]
  }
}
PHP
<?php foreach ($a['items'] as $index => $item) : ?>
  <RichText tag="h2" attribute="items[<?php echo $index; ?>].heading" placeholder="Enter heading" />
<?php endforeach; ?>
Twig
{% for item in a.items %}
  <RichText tag="h2" attribute="items[{{ loop.index0 }}].heading" placeholder="Enter heading" />
{% endfor %}

De waarde attribute volgt het patroon repeaterId[index].fieldId, waarbij index het nulgebaseerde rijnummer uit de lus is.