Saltar al contenido

RichText

Las ediciones de RichText se guardan de inmediato en los atributos del bloque y forman parte del historial de deshacer y rehacer de Gutenberg, incluso cuando RichText está dentro de filas repetidoras. Al guardar con varios bloques seleccionados, se conserva el contenido y los atributos propios de cada bloque.

El componente RichText permite mostrar un campo editable dentro del editor y un elemento HTML estático en el frontend. Se basa en el componente RichText que ofrece WordPress.

Uso básico

Para usar RichText de la forma más básica, debes añadir el atributo adecuado a tu block.json y añadir el componente RichText a tu bloque.

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

Puedes usar un número ilimitado de componentes RichText en tu bloque.

Propiedades

allowedFormats

Puedes limitar los formatos disponibles en el componente RichText mediante la propiedad 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') }}" />

placeholder

Puedes establecer un marcador de posición para el componente RichText mediante la propiedad placeholder.

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

preserveWhiteSpace

Indica si se deben conservar los caracteres de espacio en blanco del valor. Normalmente, los caracteres de tabulación, salto de línea y espacio se reducen a un único espacio. Si se activa esta opción, los saltos de línea suaves se guardarán como caracteres de nueva línea, no como elementos de salto de línea.

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

Etiqueta

De forma predeterminada, el contenido de RichText se renderiza dentro de un elemento p. Puedes cambiarlo mediante la propiedad tag.

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

withoutInteractiveFormatting

De forma predeterminada, están disponibles todos los controles de formato. Esta opción permite quitar los controles de formato que harían que el contenido fuera interactivo.

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

Campos repetidores

RichText funciona dentro de campos repetidores. Usa la notación con corchetes y el índice del bucle para seleccionar la fila correcta.

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

El valor attribute sigue el patrón repeaterId[index].fieldId, donde index es el número de fila del bucle, empezando por cero.