Skip to content

format.md

Latest commit

 

History

History
158 lines (116 loc) · 4.55 KB

format.md

File metadata and controls

158 lines (116 loc) · 4.55 KB

Формат входных данных

1. Общая структура

{
    // {String} Название группы. Например, «Blocks»
    "label": "",

    // {Object} Стили, применяемые к всем элементам группы. См. п. 2
    "styles": {},

    // {String} Текст подсказки в статусбар
    "hint": "",

    // {Array} Массив элементов группы. Например, блоков.
    "items": [
        {
            // {String} Имя элемента
            "name": "",

            // {String} Имя элемента, используется в интерфейсе
            "label": "",

            // {Object} Стили, применяемые к всем элементам группы. См. п. 2
            "styles": {},

            // {Array|Object|String} Документация. См. п. 3
            "documentation": [],

            // {Array} Массив с произвольные данными о блоке. См. п. 4
            "meta": [],

            // {String} Текст подсказки в статусбар
            "hint": "",

            "types": [
                {
                    // {String} Имя группы типов, используется в интерфейсе
                    "label": "",

                    // {Object} Стили, применяемые к всем элементам группы. См. п. 2
                    "styles": {},

                    // {String} Текст подсказки в статусбар
                    "hint": "",

                    // {Array} Массив типов
                    "items": [
                        {
                            // {String} Имя типа
                            "name": "",

                            // {String} Имя типа, используется в интерфейсе
                            "label": "",

                            // Произвольные данные типа
                            "data": {},

                            // {String} URL изображения для типа
                            "image": "",

                            // {Object} Стили, применяемые к всем элементам группы. См. п. 2
                            "styles": {},

                            // {String} Текст подсказки в статусбар
                            "hint": ""
                        }
                    ]
                }
            ]
        }
    ]
}

Если групп несколько, можно передавать в качестве данных массив объектов.

2. Стили

Объект со стилями может применяться для:

  • группы;
  • подгруппы;
  • блока;
  • группы типов блока;
  • к конкретному типу.

Структура объекта со стилями

"styles": {
    // {String} Стили, применяемыек врапперу
    "wrapper": "",

    // {String} Стили, применяемые к контейнеру с изображением
    "image": "",

    // {String} Стили, применяемые к контейнеру с версткой
    "markup"
}

3. Документация

В качестве значения можно передавать массив, объект или строку.

Массив объектов

"documentation": [
    {
        // {String} URL ссылки на статью
        "link": "",

        // {String} Название статьи. Используется в интерфейсе
        "label": "",

        // {String} Модификатор. Будет использоваться в качестве CSS-класса
        "modifier": ""
    }
],

Массив ссылок

"documentation": [
    'http://mysite.com/docs/article1/',
    'http://mysite.com/docs/article2/'
],

Строка

"documentation": 'http://mysite.com/docs/article/'

Произвольные метаданные

"meta": [
    {
        // {String} Ключ
        "key": "",

        // {String} Значение
        "value": "",

        // {Boolean} Отображать в интерфейсе
        "visible": true,

        // {String} Модификатор. Будет использоваться в качестве CSS-класса
        "modifier": ""
    }
]