Gå til indhold

RichText

RichText-redigeringer gemmes straks i blokkens attributter og indgår i Gutenbergs fortrydelses- og gentagelseshistorik, også for RichText i gentagelsesrækker. Når du gemmer, mens flere blokke er valgt, bevares hver bloks eget indhold og dens attributter.

Komponenten RichText gør det muligt at gengive et redigerbart input i editoren og et statisk HTML-element i frontend. Den er baseret på komponenten RichText, som WordPress leverer.

Grundlæggende brug

For at bruge RichText i sin enkleste form skal du føje den relevante attribut til din block.json og føje komponenten RichText til din blok.

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

Du kan bruge et ubegrænset antal RichText-komponenter i din blok.

Egenskaber

allowedFormats

Du kan begrænse, hvilke formater der kan bruges i RichText-komponenten, ved hjælp af egenskaben 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') }}" />

pladsholder

Du kan angive en pladsholder for RichText-komponenten ved hjælp af egenskaben placeholder.

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

preserveWhiteSpace

Om mellemrumstegn skal bevares i værdien. Normalt samles tabulatorer, linjeskift og mellemrum til ét enkelt mellemrum. Hvis dette aktiveres, gemmes bløde linjeskift som linjeskiftstegn i stedet for som linjeskiftselementer.

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

tag

Som standard gengives indholdet RichText i et element p. Du kan ændre dette ved hjælp af egenskaben tag.

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

withoutInteractiveFormatting

Som standard vises alle formateringskontroller. Denne indstilling kan bruges til at fjerne formateringskontroller, der gør indholdet interaktivt.

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

Gentagelsesfelter

RichText fungerer i gentagelsesfelter. Brug klammeparentesnotation med løkkens indeks for at vælge den rigtige række.

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

Værdien attribute følger mønsteret repeaterId[index].fieldId, hvor index er det nulbaserede rækkenummer fra løkken.