Блоки - это компоненты представления, которые позволяют вам формировать необходимые поля ввода данных и отображать дополнительную пояснительную информацию. Они указываются в поле view.blocks
при открытии представления. Вы можете добавить до 100 блоков в одно представление.
Заголовок (header)
Пример:
type | string* | Тип блока (для заголовков всегда header) |
text | string* | Текст заголовка (максимум - 150 символов) |
|
Обычный текст (plain_text)
Пример:
type | string* | Тип блока (для обычного текста всегда plain_text) |
text | string* | Текст (максимум - 12000 символов) |
|
Форматированный текст (markdown)
Пример:
type | string* | Тип блока (для форматированного текста всегда markdown) |
text | string* | Текст (максимум - 12000 символов) |
|
В поле text
вам необходимо прислать форматированный текст в синтаксисе markdown
. Поддерживаются конструкции, указанные в таблице ниже.
Жирный | **это жирный текст** или __это жирный текст__ |
это жирный текст |
Курсив | *это курсивный текст* или _это курсивный текст_ |
это курсивный текст |
Ссылки | [текст ссылки](https://www.google.com) | текст ссылки |
Маркированный список | - первый пункт - второй пункт - третий пункт |
|
Нумированный список | 1. первый пункт 2. второй пункт 3. третий пункт |
|
Зачеркнутный | ~~это зачеркнутый текст~~ |
|
Строчный код | `код в тексте` |
код в тексте
|
Блок кода | ``` Блок кода в две строки ``` |
Блок кода
|
Разделитель (divider)
Пример:
type | string* | Тип блока (для разделителя всегда divider) |
|
Текстовое поле (input)
Пример:
type | string* | Тип блока (для текстового поля всегда input) |
name | string* | Название, которое будет передано в ваше приложение как ключ указанного пользователем значения (максимум - 255 символов) |
label | string* | Подпись к полю (максимум - 150 символов) |
placeholder | string | Подсказка внутри поля ввода, пока оно пустое (максимум - 150 символов) |
multiline | boolean | Многострочное поле. При значении true поле отображается многострочным. |
initial_value | string | Начальное значение в поле (максимум - 3000 символов) |
min_length | integer | Минимальная длина текста, который должен написать пользователь. Если пользователь напишет меньше, он получит ошибку. Допустимые значения: от 0 до 3000 включительно. |
max_length | integer | Максимальная длина текста, который должен написать пользователь. Если пользователь напишет больше, он получит ошибку. Допустимые значения: от 1 до 3000 включительно. |
required | boolean | Обязательность. При значении true поле будет обязательным для заполнения и отмечено символом *. |
hint | string | Подсказка, которая отображается под полем серым цветом (максимум - 2000 символов) |
|
Выпадающий список (select)
Пример:
type | string* | Тип блока (для выпадающего списка всегда select) |
name | string* | Название, которое будет передано в ваше приложение как ключ указанного пользователем выбора (максимум - 255 символов) |
label | string* | Подпись к выпадающему списку (максимум - 150 символов) |
options | array of objects* | Массив доступных пунктов в выпадающем списке (максимум - 100 пунктов) |
text | string* | Отображаемый текст (максимум - 75 символов) |
value | string* | Уникальное строковое значение, которое будет передано в ваше приложение при выборе этого пункта (максимум - 150 символов) |
selected | boolean | Начальный выбор. При значении true этот пункт будет выбран изначально. Только один пункт может быть выбран. |
required | boolean | Обязательность. При значении true поле будет обязательным для заполнения и отмечено символом *. |
hint | string | Подсказка, которая отображается под выпадающим списком серым цветом (максимум - 2000 символов) |
|
Радиокнопки (radio)
Пример:
type | string* | Тип блока (для радиокнопок всегда radio) |
name | string* | Название, которое будет передано в ваше приложение как ключ указанного пользователем выбора (максимум - 255 символов) |
label | string* | Подпись к группе радиокнопок (максимум - 150 символов) |
options | array of objects* | Массив радиокнопок (максимум - 10 радиокнопок) |
text | string* | Отображаемый текст (максимум - 75 символов) |
value | string* | Уникальное строковое значение, которое будет передано в ваше приложение при выборе этого пункта (максимум - 150 символов) |
description | string | Пояснение, которое будет указано серым цветом в этом пункте под отображаемым текстом (максимум - 75 символов) |
checked | boolean | Выбрано. При значении true этот пункт будет выбран изначально. Только один пункт может быть выбран. |
required | boolean | Обязательность. При значении true поле будет обязательным для заполнения и отмечено символом *. |
hint | string | Подсказка, которая отображается под группой радиокнопок серым цветом (максимум - 2000 символов) |
|
Чекбоксы (checkbox)
Пример:
type | string* | Тип блока (для чекбоксов всегда checkbox) |
name | string* | Название, которое будет передано в ваше приложение как ключ указанного пользователем выбора (максимум - 255 символов) |
label | string* | Подпись к группе чекбоксов (максимум - 150 символов) |
options | array of objects* | Массив чекбоксов (максимум - 10 чекбоксов) |
text | string* | Отображаемый текст (максимум - 75 символов) |
value | string* | Уникальное строковое значение, которое будет передано в ваше приложение при выборе этого пункта (максимум - 150 символов) |
description | string | Пояснение, которое будет указано серым цветом в этом пункте под отображаемым текстом (максимум - 75 символов) |
checked | boolean | Выбрано. При значении true этот пункт будет выбран изначально. |
required | boolean | Обязательность. При значении true поле будет обязательным для заполнения и отмечено символом *. |
hint | string | Подсказка, которая отображается под группой чекбоксов серым цветом (максимум - 2000 символов) |
|
Выбор даты (date)
Пример:
type | string* | Тип блока (для выбора даты всегда date) |
name | string* | Название, которое будет передано в ваше приложение как ключ указанного пользователем значения (максимум - 255 символов) |
label | string* | Подпись к полю (максимум - 150 символов) |
initial_date | string | Начальное значение в поле в формате YYYY-MM-DD |
required | boolean | Обязательность. При значении true поле будет обязательным для заполнения и отмечено символом *. |
hint | string | Подсказка, которая отображается под полем серым цветом (максимум - 2000 символов) |
|
Выбор времени (time)
Пример:
type | string* | Тип блока (для выбора времени всегда time) |
name | string* | Название, которое будет передано в ваше приложение как ключ указанного пользователем значения (максимум - 255 символов) |
label | string* | Подпись к полю (максимум - 150 символов) |
initial_time | string | Начальное значение в поле в формате HH:mm |
required | boolean | Обязательность. При значении true поле будет обязательным для заполнения и отмечено символом *. |
hint | string | Подсказка, которая отображается под полем серым цветом (максимум - 2000 символов) |
|
Загрузка файлов (file_input)
Пример:
type | string* | Тип блока (для загрузки файлов всегда file_input) |
name | string* | Название, которое будет передано в ваше приложение как ключ указанного пользователем значения (максимум - 255 символов) |
label | string* | Подпись к полю (максимум - 150 символов) |
filetypes | array of strings | Массив допустимых расширений файлов, указанные в виде строк (например, ["png","jpg","gif"]). Если это поле не указано, все расширения файлов будут приняты. |
max_files | integer | Максимальное количество файлов, которое может загрузить пользователь в это поле. Допустимые значения: от 1 до 10 включительно. По умолчанию - 10 файлов. |
required | boolean | Обязательность. При значении true поле будет обязательным для заполнения и отмечено символом *. |
hint | string | Подсказка, которая отображается под полем серым цветом (максимум - 2000 символов) |
|