Меню домена

Этот раздел описывает меню домена.

Структура `menus`

Путь в схеме: menus[]

Поле menus представляет собой массив записей элементов меню. Каждый элемент массива имеет следующую структуру:

Поле Обязательное поле Описание Комментарий

Поле	Обязательное поле	Описание	Комментарий
`id`	да	Идентификатор элемента меню.	View ID
`description`	нет	Описание меню. Не выводится в представлениях.	строка
`route`	да	Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера. Фактически определяет путь в адресной строке, по которому можно перейти на целевую страницу. Пути должны быть уникальными как в рамках одной схемы домена, так и в разных схемах.	путь в URL
`label`	да	Отображаемое в меню системы название раздела домена.	строка
`icon`	нет	Ссылка на медиа-ресурс.	строка
`type`	да	Тип элемента меню: `root_group` — корневая группа элементов меню, включающая названия раздела домена и подразделов сущностей. Количество корневых групп не ограничено. `root_menu` — элемент меню, не включенный в корневую группу.	перечисление
`placement`	да	Настройки расположения меню в левой панели: `top` — в главном меню системы; `settings` — в разделе Настройки главного меню.	перечисление
`priority`	нет	Параметр, определяющий положение в главном меню, чем больше — тем выше в списке. Значение должно быть не меньше `1000`.	целое число
`view`	да	Ссылка на списочное представление или на представление списков с вкладками. Поле доступно только для типа `root_menu`.	View ID Ref
`items`	да	Дочерние элементы для корневой группы меню. Массив записей меню с подразделами типов сущностей. Используется для типа элементов меню `root_menu`. Ознакомьтесь с описанием поля `items`.	массив

id

да

Идентификатор элемента меню.

View ID

description

нет

Описание меню. Не выводится в представлениях.

строка

route

да

Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера. Фактически определяет путь в адресной строке, по которому можно перейти на целевую страницу.

Пути должны быть уникальными как в рамках одной схемы домена, так и в разных схемах.

путь в URL

label

да

Отображаемое в меню системы название раздела домена.

строка

icon

нет

Ссылка на медиа-ресурс.

строка

type

да

Тип элемента меню:

root_group — корневая группа элементов меню, включающая названия раздела домена и подразделов сущностей.

Количество корневых групп не ограничено.
root_menu — элемент меню, не включенный в корневую группу.

перечисление

placement

да

Настройки расположения меню в левой панели:

top — в главном меню системы;
settings — в разделе Настройки главного меню.

перечисление

priority

нет

Параметр, определяющий положение в главном меню, чем больше — тем выше в списке. Значение должно быть не меньше 1000.

целое число

view

да

Ссылка на списочное представление или на представление списков с вкладками.

Поле доступно только для типа root_menu.

View ID Ref

items

да

Дочерние элементы для корневой группы меню. Массив записей меню с подразделами типов сущностей. Используется для типа элементов меню root_menu.

Ознакомьтесь с описанием поля items.

массив

Дочерние элементы корневой группы (`items`)

Путь в схеме: menus[].items[]

Поле items используется для создания массива записей пунктов меню в разделе домена. Каждый элемент массива имеет следующую структуру:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`id`	да	Идентификатор элемента меню.	View ID
`description`	нет	Описание меню. Не выводится в представлениях.	строка
`route`	да	Компонент адреса текущего пункта меню, отображаемый в строке веб-браузера. Фактически определяет путь в адресной строке, по которому можно перейти на целевую страницу.	путь в URL
`label`	да	Отображаемое в меню системы название пункта меню.	строка
`type`	да	Тип элемента меню. Устанавливается значение `menu` — дочерний элемент меню, который может быть задан только в рамках массива элементов корневой группы.	перечисление
`view`	да	Ссылка на представление. Ссылка на списочное представление или на представление списков с вкладками.	View ID Ref
`priority`	нет	Параметр, определяющий положение элемента в корневом меню, чем больше — тем выше в списке. Значение должно быть не меньше `1000`.	целое число

id

да

Идентификатор элемента меню.

View ID

description

нет

Описание меню. Не выводится в представлениях.

строка

route

да

путь в URL

label

да

Отображаемое в меню системы название пункта меню.

строка

type

да

Тип элемента меню.

Устанавливается значение menu — дочерний элемент меню, который может быть задан только в рамках массива элементов корневой группы.

перечисление

view

да

Ссылка на представление. Ссылка на списочное представление или на представление списков с вкладками.

View ID Ref

priority

нет

Параметр, определяющий положение элемента в корневом меню, чем больше — тем выше в списке. Значение должно быть не меньше 1000.

целое число

Была ли полезна эта страница?

Меню домена

Структура menus

Дочерние элементы корневой группы (items)

Структура `menus`

Дочерние элементы корневой группы (`items`)