Gå til indhold

Registrering af attributter

Attributter defineres i arrayet blockstudio.attributes i din fil block.json.

Grundlæggende eksempel

JSON
{
  "name": "my-theme/my-block",
  "title": "My Block",
  "blockstudio": {
    "attributes": [
      {
        "id": "title",
        "type": "text",
        "label": "Title"
      },
      {
        "id": "content",
        "type": "textarea",
        "label": "Content"
      }
    ]
  }
}

Attributegenskaber

Alle attributter har følgende egenskaber:

Egenskab Type Beskrivelse
id string Entydig identifikator for attributten
type string Felttypen (text, textarea, select osv.)
label string Etiket, der vises i editoren
default mixed Standardværdi for attributten
help string Hjælpetekst, der vises som et værktøjstip ved siden af etiketten
position string Hvor feltet vises: inspector (standard) eller toolbar
conditions array Betinget logik til at vise eller skjule feltet

Placering

Som standard vises alle felter i blokinspektøren (sidepanelet). Du kan ændre det med egenskaben position:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "alignment",
        "type": "select",
        "label": "Alignment",
        "position": "toolbar",
        "options": [
          { "value": "left", "label": "Left" },
          { "value": "center", "label": "Center" },
          { "value": "right", "label": "Right" }
        ]
      }
    ]
  }
}

Standardværdier

Angiv standardværdier med egenskaben default:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "title",
        "type": "text",
        "label": "Title",
        "default": "Hello World"
      },
      {
        "id": "showBorder",
        "type": "toggle",
        "label": "Show Border",
        "default": true
      }
    ]
  }
}

Hjælpetekst

Tilføj hjælpetekst for at vejlede brugerne:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "apiKey",
        "type": "text",
        "label": "API Key",
        "help": "Enter your API key from the settings page"
      }
    ]
  }
}

Adgang til attributter

I din skabelon er attributterne tilgængelige via den korte notation $a (eller $attributes):

PHP
<h1><?php echo $a['title']; ?></h1>
<p><?php echo $a['content']; ?></p>

Eller i Twig:

Twig
<h1>{{ a.title }}</h1>
<p>{{ a.content }}</p>

Field Patterns Cookbook