Страницы

Тип метаданных

page

Библиотека компонентов

http://n2oapp.net/framework/config/schema/page-3.0

<simple-page>#

Страница с единственным виджетом.

Пример

<?xml version='1.0' encoding='UTF-8'?><simple-page xmlns="http://n2oapp.net/framework/config/schema/page-3.0"    name="Моя страница">    <form>...</form></simple-page>

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
name	Строка	Наименование страницы	Берётся из виджета
title	Строка	Заголовок страницы
html-title	Строка	Заголовок вкладки браузера	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
show-title	true false	Показывать заголовок страницы?	false

Тело

Виджет

<page>#

Страница с регионами.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
object-id	Ссылка на объект	Главный объект страницы

Тело

Список регионов

Пример

<?xml version='1.0' encoding='UTF-8'?><page xmlns="http://n2oapp.net/framework/config/schema/page-3.0"    name="Моя страница">    <regions>...</regions>    <actions>...</actions>    <toolbar>...</toolbar></page>

<left-right-page>#

Страница с двумя регионами.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
object-id	Ссылка на объект	Главный объект страницы

Тело

Регионы <left> <right>

Пример

<?xml version='1.0' encoding='UTF-8'?><left-right-page xmlns="http://n2oapp.net/framework/config/schema/page-3.0"    name="Моя страница">    <actions>...</actions>    <toolbar>...</toolbar>    <left>...</left>    <right>...</right></left-right-page>

<top-left-right-page>#

Страница с тремя регионами.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
object-id	Ссылка на объект	Главный объект страницы
scroll-top-button	true false	Показывается ли кнопка скролла в начало страницы	false

Тело

Регионы <top> <left> <right>

Пример

<?xml version='1.0' encoding='UTF-8'?><top-left-right-page xmlns="http://n2oapp.net/framework/config/schema/page-3.0"    name="Моя страница">    <actions>...</actions>    <toolbar>...</toolbar>    <top>...</top>    <left>...</left>    <right>...</right></top-left-right-page>

<searchable-page>#

Страница с поисковой строкой.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
object-id	Ссылка на объект	Главный объект страницы

Тело

Поисковая строка

Пример

<?xml version='1.0' encoding='UTF-8'?><searchable-page xmlns="http://n2oapp.net/framework/config/schema/page-3.0"    name="Моя страница">    <search-bar/>    <regions>...</regions>    <actions>...</actions>    <toolbar>...</toolbar></page>

<regions>#

Регионы страницы.

Тело

Список регионов Список виджетов

Пример

<regions>  <form>...</form>  <tabs>...</tabs>  <line>...</line>  <panel>...</panel></regions>

<actions>#

Действия страницы.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
generate	crud, submit, close	Генерация стандартных действий

Пример

<actions generate="save, close">  <action>...</action>  <action>...</action>  <action>...</action></actions>

<action>#

Действие над страницей.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор действия
name	Строка	Наименование	Вычисляется по операции объекта
icon	CSS класс	Иконка действия	Вычисляется, если `id` действия из списка стандартных действий.
hotkey	Сочетание клавиш	Горячая клавиша вызова	Вычисляется, если `id` действия из списка стандартных действий. Например, для `save` горячая клавиша `Enter`.
visible	true false	Видимость действия	true
enabled	true false	Доступность действия	true

Тело

Обработчик действия

Пример

<action  id="save">  <invoke    operation-id="update"    model="edit"    confirm="false"/></action>

<toolbar>#

Меню управляющих кнопок страницы.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
place	topLeft, topRight, bottomLeft, bottomRight, breadcrumbLeft	Место расположения меню	topLeft
generate	crud, submit, close	Генерация стандартных кнопок

Пример

<toolbar place="topLeft" generate="submit, close">  <group>...</group>  <button>...</button>  <sub-menu>...</sub-menu></toolbar>

<left> <right>#

Регионы <left-right-page>.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
width	Строка	Ширина региона

Пример

<left width="40%">...</left><right width="60%">...</right>

Тело

Список регионов Список виджетов

<top> <left> <right>#

Регионы <top-left-right-page>.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
width	Строка	Ширина региона
fixed	true false	Зафиксирован ли регион. Фиксироваться может максимум 2 региона из 3	false
offset	Число	Отступ от верхней границы при фиксировании

Пример

<top fixed="true" offset="100">...</top><left width="40%">...</left><right fixed="true" width="60%" offset="100">...</right>

Тело

Список регионов Список виджетов

<search-bar>#

Поисковая строка.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
class	Строка	CSS класс стилей
placeholder	Строка	Подсказка для ввода
search-widget-id	Строка	Идентификатор виджета для которого производится поиск	Главный виджет страницы
search-filter-id	Строка	Идентификатор фильтра
search-param	Строка	Параметр поиска	Идентификатор виджета + Идентификатор фильтра (table_name)

Пример

<search-bar button-label="Искать" search-widget-id="main" search-filter-id="name"/>

<menu-item>#

Пункт выпадающего меню.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
action-id	Ссылка на действие виджета	Действие виджета, которое будет вызвано при нажатии на кнопку
label	Строка	Заголовок пункта меню	Вычисляется из `action-id`
icon	CSS класс	Иконка пункта меню	Вычисляется из `action-id`
class	CSS класс	CSS класс пункта меню
style	CSS свойство	Стиль пункта меню

Пример

<menu-item action-id="create"/>

<menu-item label="Удалить запись" icon="fa-trash">  <invoke operations-id="delete"/></menu-item>

<group>#

Группа кнопок.

Тело

Список кнопок или кнопок с выпадающим меню

Пример

<group>    <button>...</button>    <sub-menu>...</sub-menu></group>

Регионы#

Библиотека компонентов

http://n2oapp.net/framework/config/schema/region-2.0

Базовые свойства#

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор региона	Местоположение региона на странице + порядковый номер
place	Строка	Местоположение региона на странице
src	React компонент	Реализация региона	Для каждого вида региона своё значение по умолчанию
class	CSS класс	CSS класс панели
style	CSS свойство	Стиль панели

<tabs>#

Регион в виде вкладок.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
always-refresh	true false	Возможность обновления данных при переключении между вкладками	false
lazy	true false	Ленивая загрузка вкладок	true
active-param	Строка	Имя параметра активной вкладки в URL
routable	true false	Восстановление активных вкладок по URL	true
hide-single-tab	true false	Скрытие единственной доступной вкладки и отображение только ее содержимого	false
max-height	Строка	Максимальная высота содержимого вкладок
scrollbar	true false	Отображение полосы прокрутки	false

Пример

<tabs always-refresh="true">  <tab> <!-- Первая вкладка -->    ...  </tab>  <tab> <!-- Вторая вкладка -->    ...  </tab></tabs>

<tab>#

Вкладка.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор вкладки
name	Строка	Наименование вкладки

Пример

<tab id="tab1" name="Вкладка">  <form/>  <panel/>  <table/></tab>

Тело

Список регионов Список виджетов

<line>#

Регион с горизонтальным делителем.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
label	Строка	Заголовок региона
collapsible	true false	Возможность раскрытия и сворачивания региона	true
has-separator	true false	Наличие горизонтального делителя	true
expand	true false	Исходное раскрытие региона	true

Пример

<line collapsible="true" label="Line1">  <table/>  <panel/>  <form/></line>

Тело

Список регионов Список виджетов

<panel>#

Регион в виде панелей.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
title	Строка	Заголовок
collapsible	true false	Возможность раскрытия и сворачивания содержимого панели	true
header	true false	Наличие заголовка	true
icon	CSS класс	Класс иконки
color	Строка	Стиль панели
open	true false	Раскрытие панели	true
footer-title	Строка	Заголовок для подвала региона

Пример

<panel collapsible="true" class="bg-primary">  <form/>  <line/>  <table/></panel>

Тело

Список регионов Список виджетов

<region>#

Кастомный регион.

Пример

<region>  <table/>  <tabs/>  <form/></region>

Тело

Список регионов Список виджетов

<simple-page>#

<page>#

<left-right-page>#

<top-left-right-page>#

<searchable-page>#

<regions>#

<actions>#

<action>#

<toolbar>#

<left> <right>#

<top> <left> <right>#

<search-bar>#

<button>#

<sub-menu>#

<link>#

<menu-item>#

<group>#

Регионы#

Базовые свойства#

<tabs>#

<tab>#

<line>#

<panel>#

<region>#