RichText
Edycje RichText są od razu zapisywane w atrybutach bloku i uwzględniane w historii cofania i ponawiania Gutenberg, także w przypadku RichText w wierszach pól powtarzalnych. Zapisanie zmian przy zaznaczonych kilku blokach zachowuje treść i atrybuty każdego z nich.
Komponent RichText umożliwia renderowanie edytowalnego pola w edytorze i statycznego elementu HTML w interfejsie witryny. Bazuje na komponencie RichText udostępnianym przez WordPress.
Podstawowe użycie
Aby użyć RichText w najprostszej postaci, dodaj odpowiedni atrybut do block.json oraz komponent RichText do bloku.
{
"$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" />
W bloku możesz użyć dowolnej liczby komponentów RichText.
Właściwości
allowedFormats
Możesz ograniczyć formaty dostępne w komponencie RichText za pomocą właściwości allowedFormats.
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') }}" />
Symbol zastępczy
Możesz ustawić symbol zastępczy komponentu RichText za pomocą właściwości placeholder.
<RichText attribute="myRichText" placeholder="Enter some text" />
preserveWhiteSpace
Czy zachować znaki białych spacji w wartości. Zwykle znaki tabulacji, nowego wiersza i spacji są sprowadzane do pojedynczej spacji. Po włączeniu tej opcji miękkie podziały wiersza będą zapisywane jako znaki nowego wiersza, a nie jako elementy podziału wiersza.
<RichText attribute="myRichText" preserveWhiteSpace="true" />
tag
Domyślnie treść RichText jest renderowana wewnątrz elementu p. Możesz to zmienić za pomocą właściwości tag.
<RichText attribute="myRichText" tag="h1" />
withoutInteractiveFormatting
Domyślnie dostępne są wszystkie kontrolki formatowania. To ustawienie pozwala usunąć kontrolki, które umożliwiałyby interakcję z treścią.
<RichText attribute="myRichText" withoutInteractiveFormatting="true" />
Pola powtarzalne
RichText działa w polach powtarzalnych. Użyj notacji nawiasowej z indeksem pętli, aby wskazać właściwy wiersz.
{
"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 %}
Wartość attribute ma postać repeaterId[index].fieldId, gdzie index to numer wiersza w pętli, liczony od zera.