Pular para o conteúdo

RichText

As edições de RichText são salvas imediatamente nos atributos do bloco e fazem parte do histórico de desfazer e refazer de Gutenberg, incluindo RichText dentro de linhas repetidoras. Salvar enquanto vários blocos estão selecionados preserva o conteúdo e os atributos próprios de cada bloco.

O componente RichText permite renderizar uma entrada editável dentro do editor e um elemento HTML estático no frontend. Ele se baseia no componente RichText fornecido por WordPress.

Uso básico

Para usar RichText em sua forma mais básica, você precisa adicionar o atributo apropriado ao seu block.json e adicionar o componente RichText ao seu bloco.

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

Você pode usar uma quantidade ilimitada de componentes RichText no seu bloco.

Propriedades

allowedFormats

Você pode limitar os formatos permitidos no componente RichText usando a propriedade 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

Você pode definir um placeholder para o componente RichText usando a propriedade placeholder.

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

preserveWhiteSpace

Se os caracteres de espaço em branco devem ser preservados no valor. Normalmente, tabulações, quebras de linha e espaços são reduzidos a um único espaço. Quando ativado, quebras de linha suaves são salvas como caracteres de nova linha, e não como elementos de quebra de linha.

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

tag

Por padrão, o conteúdo de RichText é renderizado dentro de um elemento p. Você pode alterar isso usando a propriedade tag.

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

withoutInteractiveFormatting

Por padrão, todos os controles de formatação estão presentes. Essa configuração pode ser usada para remover controles de formatação que tornariam o conteúdo interativo.

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

Campos repetidores

RichText funciona dentro de campos repetidores. Use a notação de colchetes com o índice do loop para selecionar a linha correta.

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

O valor attribute segue o padrão repeaterId[index].fieldId, em que index é o número da linha, começando em zero, no loop.