RichText
Änderungen mit RichText werden sofort in den Attributen des Blocks gespeichert und sind Teil von Gutenbergs Rückgängig- und Wiederherstellungsverlauf. Das gilt auch für RichText in Repeater-Zeilen. Beim Speichern mit mehreren ausgewählten Blöcken bleiben Inhalt und Attribute jedes Blocks erhalten.
Mit der Komponente RichText kannst du im Editor ein bearbeitbares Eingabefeld und im Frontend ein statisches HTML-Element rendern. Sie basiert auf der Komponente RichText, die WordPress bereitstellt.
Grundlegende Verwendung
Um RichText in der einfachsten Form zu verwenden, musst du das passende Attribut zu deinem block.json hinzufügen und die Komponente RichText in deinen Block einfügen.
{
"$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"
}
]
}
}
<RichText attribute="myRichText" />
Du kannst beliebig viele RichText-Komponenten in deinem Block verwenden.
Eigenschaften
allowedFormats
Mit der Prop allowedFormats kannst du die Formate beschränken, die in der RichText-Komponente verwendet werden dürfen.
PHP
<RichText attribute="myRichText" allowedFormats="<?php echo esc_attr(wp_json_encode(['core/bold', 'core/italic'])); ?>" />
Twig
<RichText attribute="myRichText" allowedFormats="{{ ['core/bold', 'core/italic']|json_encode|escape('html_attr') }}" />
placeholder
Mit der Prop placeholder kannst du einen Platzhalter für die RichText-Komponente festlegen.
<RichText attribute="myRichText" placeholder="Enter some text" />
preserveWhiteSpace
Gibt an, ob Leerraumzeichen im Wert beibehalten werden. Normalerweise werden Tabulatoren, Zeilenumbrüche und Leerzeichen zu einem einzelnen Leerzeichen zusammengefasst. Wenn diese Option aktiviert ist, werden weiche Zeilenumbrüche als Zeilenumbruchzeichen statt als Zeilenumbruchelemente gespeichert.
<RichText attribute="myRichText" preserveWhiteSpace="true" />
tag
Standardmäßig wird der Inhalt von RichText in einem p-Element gerendert. Mit der Prop tag kannst du das ändern.
<RichText attribute="myRichText" tag="h1" />
withoutInteractiveFormatting
Standardmäßig sind alle Formatierungssteuerelemente vorhanden. Mit dieser Einstellung kannst du Formatierungssteuerelemente entfernen, durch die der Inhalt interaktiv würde.
<RichText attribute="myRichText" withoutInteractiveFormatting="true" />
Repeater-Felder
RichText funktioniert in Repeater-Feldern. Verwende die Klammernotation mit dem Schleifenindex, um die richtige Zeile anzusprechen.
{
"blockstudio": {
"attributes": [
{
"id": "items",
"type": "repeater",
"attributes": [
{
"id": "heading",
"type": "richtext"
}
]
}
]
}
}
<?php foreach ($a['items'] as $index => $item) : ?>
<RichText tag="h2" attribute="items[<?php echo $index; ?>].heading" placeholder="Enter heading" />
<?php endforeach; ?>
{% for item in a.items %}
<RichText tag="h2" attribute="items[{{ loop.index0 }}].heading" placeholder="Enter heading" />
{% endfor %}
Der Wert attribute folgt dem Muster repeaterId[index].fieldId, wobei index die nullbasierte Zeilennummer der Schleife ist.