Aller au contenu

RichText

Les modifications de RichText sont enregistrées immédiatement dans les attributs du bloc et intégrées à l’historique d’annulation et de rétablissement de Gutenberg, y compris pour RichText dans les lignes répétables. Enregistrer lorsque plusieurs blocs sont sélectionnés préserve le contenu et les attributs propres à chaque bloc.

Le composant RichText permet d’afficher un champ modifiable dans l’éditeur et un élément HTML statique sur le frontend. Il est basé sur le composant RichText fourni par WordPress.

Utilisation de base

Pour utiliser RichText sous sa forme la plus simple, ajoutez l’attribut approprié à votre block.json et le composant RichText à votre bloc.

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

Vous pouvez utiliser autant de composants RichText que vous le souhaitez dans votre bloc.

Propriétés

allowedFormats

Vous pouvez limiter les formats disponibles dans le composant RichText à l’aide de la propriété 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

Vous pouvez définir un espace réservé pour le composant RichText à l’aide de la propriété placeholder.

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

preserveWhiteSpace

Indique s’il faut préserver les espaces dans la valeur. Normalement, les tabulations, les retours à la ligne et les espaces sont réduits à une seule espace. Si cette option est activée, les sauts de ligne souples sont enregistrés sous forme de caractères de nouvelle ligne, et non d’éléments de saut de ligne.

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

tag

Par défaut, le contenu RichText est affiché dans un élément p. Vous pouvez modifier ce comportement à l’aide de la propriété tag.

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

withoutInteractiveFormatting

Par défaut, toutes les commandes de mise en forme sont présentes. Ce réglage permet de supprimer celles qui rendraient le contenu interactif.

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

Champs répétables

RichText fonctionne dans les champs répétables. Utilisez la notation entre crochets avec l’index de la boucle pour cibler la bonne ligne.

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

La valeur attribute suit le modèle repeaterId[index].fieldId, où index représente le numéro de ligne de la boucle, en commençant à zéro.