Перейти к содержимому

RichText

Изменения RichText сразу сохраняются в атрибутах блока и учитываются в истории отмены и повтора действий Gutenberg, в том числе для RichText внутри строк повторителя. При сохранении с выбранными несколькими блоками сохраняется содержимое и атрибуты каждого блока.

Компонент RichText позволяет выводить редактируемое поле ввода в редакторе и статический элемент HTML во внешнем интерфейсе. Он основан на компоненте RichText, который предоставляет WordPress.

Основы использования

Для базового использования RichText добавьте соответствующий атрибут в block.json и компонент RichText в блок.

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" />

В блоке можно использовать неограниченное количество компонентов RichText.

Свойства

allowedFormats

Список форматов, доступных в компоненте RichText, можно ограничить с помощью свойства 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') }}" />

заполнитель

Задайте для компонента RichText заполнитель с помощью свойства placeholder.

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

preserveWhiteSpace

Определяет, сохранять ли пробельные символы в значении. Обычно символы табуляции, новой строки и пробела сворачиваются в один пробел. Если параметр включен, мягкие переносы строк сохраняются как символы новой строки, а не как элементы переноса строки.

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

тег

По умолчанию содержимое RichText выводится внутри элемента p. Изменить это можно с помощью свойства tag.

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

withoutInteractiveFormatting

По умолчанию доступны все элементы управления форматированием. С помощью этого параметра можно убрать элементы управления, которые делают контент интерактивным.

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

Поля-повторители

RichText работает в полях-повторителях. Используйте квадратные скобки с индексом цикла, чтобы обратиться к нужной строке.

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 %}

Значение attribute соответствует шаблону repeaterId[index].fieldId, где index — номер строки в цикле, начиная с нуля.