Hoppa till innehåll

Åsidosättningar

Blockstudio gör det möjligt att åsidosätta block på en mycket detaljerad nivå. Det kan vara användbart för delade blockbibliotek när du vill ändra ett blocks beteende utan att behöva skapa ett nytt block från grunden.

block.json

Börja med att ange namnet på blocket du vill åsidosätta som nyckel name och sätt nyckeln override till true.

JSON
{
  "name": "blockstudio/my-block",
  "title": "My overridden block title",
  "blockstudio": {
    "override": true
  }
}

När egenskapen override är inställd på true slås data från det nya block.json samman med data från det ursprungliga blocket. Det innebär att du kan åsidosätta vilken egenskap som helst i originalblocket.

Attribut

Attribut kan antingen åsidosättas med id eller läggas till. Tänk dig till exempel att vi vill åsidosätta ett blocks attribut width och lägga till ett nytt attribut height.

JSON
{
  "name": "blockstudio/my-block",
  "title": "My overridden block title",
  "blockstudio": {
    "override": true,
    "attributes": [
      {
        "id": "width",
        "type": "number",
        "default": 280,
        "label": "Override width"
      },
      {
        "id": "height",
        "type": "number",
        "default": 280,
        "label": "New height"
      }
    ]
  }
}

När ett attribut med samma id hittas slås data samman med det ursprungliga attributet. Attribut som inte hittas läggs till i blocket.

Varning

När du åsidosätter attribut måste du ange det ursprungliga attributets type, även om det förblir oförändrat.

Komplexa strukturer

När du åsidosätter attribut med komplexa strukturer (upprepningsfält, grupper, flikar osv.) måste du ange attributets fullständiga struktur fram till den punkt där objektet som ska åsidosättas finns.

JSON
{
  "name": "blockstudio/my-block",
  "blockstudio": {
    "override": true,
    "attributes": [
      {
        "id": "tabs",
        "type": "tabs",
        "tabs": [
          {
            "id": "tab1",
            "attributes": [
              {
                "key": "group1",
                "type": "group",
                "title": "Group",
                "attributes": [
                  {
                    "id": "text",
                    "type": "text",
                    "label": "Override text"
                  }
                ]
              }
            ]
          },
          {
            "id": "tab2",
            "title": "Override tab",
            "attributes": [
              {
                "id": "group",
                "type": "group",
                "title": "Group ID",
                "attributes": [
                  {
                    "id": "text",
                    "type": "text",
                    "label": "Override text"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Resurser

Tillgångsfiler ersätts när filnamnet matchar. Om det till exempel finns en style.css-fil i originalblocket ersätts den med filen style.css i det åsidosättande blocket. Filer med namn som inte matchar originalblockets läggs till i blocket.

Renderingsmall

Renderingsmallar kan åsidosättas genom att en ny mallfil anges, alltså index.php, index.twig eller index.blade.php.

Twig-block

Twig-mallar kan åsidosättas på en mer detaljerad nivå med funktionen block i Twig.

Tänk dig följande renderingsmall för ett påhittat bildblock:

Twig
<h1>Images:</h1>
{% for image in a.images %}
  <div class="content">
    {% block image %}
      <img src="{{ image.url }}" class="image" />
    {% endblock %}
  </div>
{% endfor %}

I stället för att ersätta hela mallen kan vi använda funktionen Twigs extends för att åsidosätta vissa delar av mallen och samtidigt behålla resten intakt.

Twig
{% extends 'index.twig' %}

{% block image %}
  <figure>
    <img src="{{ image.url }}" class="image" />
    <figcaption>{{ image.caption }}</figcaption>
  </figure>
{% endblock %}