Файл settings.json

Введение

Файл содержит в себе всю информацию о настройках темы в формате JSON.

Используется формат "имя_параметра": <объект настройки>

Объект настройки содержит несколько параметров

Параметр	Описание	Обязателен?
entity	Имя сущности
displayName	Отображаемое имя. Перезапишет displayName сущности (для повторного использования одной сущности)
defaultValue	Значение по умолчанию (для сущностей с одним полем)

Сущности настройки

Сущность является обычным JSON объектом с информацией о себе

Поле	Описание
displayName	Отображаемое имя сущности
maxCount	Количество возможных копий объекта. Копии создаются в панели администратора конечным пользователем. Если может быть только одно значение, то в поле должно лежать значение 1
fields	Ассоциативный объект с сущностями полей

Сущность поля

Все поля являются обязательными

Поле	Описание
displayName	Отображаемое имя поля
type	Тип поля
default	Значение по умолчанию

Доступные типы полей

Тип	Описание
text	Обычное текстовое поле
checkbox	Флаг включения или отключения какого-либо параметра
textarea	Большое поле ввода (textarea)
ck-editor	Гибкий редактор с большим функционалом. Подходит, например, для больших блоков текста

Пример файлов настроек

entity/boolean.json

{
  "displayName": "Переключатель",
  "maxCount": 1,
  "fields": {
    "enabled": {
      "displayName": "Включено",
      "type": "checkbox",
      "default": true
    }
  }
}

entity/contact.json

{
  "displayName": "Контакт",
  "maxCount": 6,
  "fields": {
    "name": {
      "displayName": "Название",
      "type": "text",
      "default": "VK"
    },
    "value": {
      "displayName": "Текст",
      "type": "text",
      "default": "https://vk.com/egocms"
    },
    "isLink": {
      "displayName": "Это ссылка",
      "type": "checkbox",
      "default": true
    },
    "blank": {
      "displayName": "Открывать в новой вкладке (только если ссылка)",
      "type": "checkbox",
      "default": true
    }
  }
}

settings.json

{
  "block1": {
    "entity": "boolean",
    "displayName": "Включить блок 1"
  },
  "block2": {
    "entity": "boolean",
    "displayName": "Включить блок 2"
  },
  "block3": {
    "entity": "boolean",
    "displayName": "Включить блок 3"
  },
  "contact": {
    "entity": "contact"
  }
}

За "живым" примером можно обратиться к настройкам стандартной темы :)