RichText
Зміни RichText одразу зберігаються в атрибутах блока та входять до історії скасування й повторення дій Gutenberg, зокрема для RichText у рядках повторювача. Під час збереження з вибраними кількома блоками кожен блок зберігає власний вміст і атрибути.
Компонент RichText дає змогу виводити редаговане поле в редакторі та статичний елемент HTML на фронтенді. Він створений на основі компонента RichText, який надає WordPress.
Основне використання
Щоб використовувати RichText у найпростішому вигляді, додайте відповідний атрибут до block.json і компонент RichText до свого блока.
{
"$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" />
У блоці можна використовувати необмежену кількість компонентів RichText.
Властивості
allowedFormats
Можна обмежити доступні формати в компоненті RichText за допомогою властивості 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') }}" />
заповнювач
Можна задати заповнювач для компонента RichText за допомогою властивості placeholder.
<RichText attribute="myRichText" placeholder="Enter some text" />
preserveWhiteSpace
Чи потрібно зберігати пробільні символи у значенні. Зазвичай символи табуляції, нового рядка та пробілу згортаються в один пробіл. Якщо ввімкнути цей параметр, м’які розриви рядка зберігатимуться як символи нового рядка, а не як елементи розриву рядка.
<RichText attribute="myRichText" preserveWhiteSpace="true" />
Тег
За замовчуванням вміст RichText виводиться всередині елемента p. Це можна змінити за допомогою властивості tag.
<RichText attribute="myRichText" tag="h1" />
withoutInteractiveFormatting
За замовчуванням доступні всі елементи керування форматуванням. Цей параметр можна використати, щоб прибрати елементи керування форматуванням, які роблять вміст інтерактивним.
<RichText attribute="myRichText" withoutInteractiveFormatting="true" />
Поля повторювача
RichText працює в полях повторювача. Використовуйте дужковий запис з індексом циклу, щоб указати потрібний рядок.
{
"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 %}
Значення attribute має формат repeaterId[index].fieldId, де index — номер рядка в циклі, починаючи з нуля.