Перейти до вмісту

Реєстрація атрибутів

Атрибути визначаються в масиві blockstudio.attributes файлу block.json.

Базовий приклад

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

Властивості атрибутів

Усі атрибути мають такі властивості:

Властивість Тип Опис
id string Унікальний ідентифікатор атрибута
type string Тип поля (text, textarea, select тощо)
label string Мітка, що відображається в редакторі
default mixed Значення атрибута за замовчуванням
help string Текст підказки, що відображається як спливаюча підказка поруч із міткою
position string Розташування поля: inspector (за замовчуванням) або toolbar
conditions array Умовна логіка відображення або приховування поля

Розташування

За замовчуванням усі поля відображаються в інспекторі блока (бічній панелі). Це можна змінити за допомогою властивості 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" }
        ]
      }
    ]
  }
}

Значення за замовчуванням

Задавайте значення за замовчуванням за допомогою властивості default:

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

Текст підказки

Додайте текст підказки, щоб зорієнтувати користувачів:

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

Доступ до атрибутів

У шаблоні атрибути доступні через скорочений запис $a (або $attributes):

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

Або в Twig:

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

Кулінарна книга шаблонів полів