Подключение библиотечного UI в прикладной проект

Предусловия

Для успешного подключения в прикладной проект библиотечных веб-компонентов должны быть выполнены следующие условия:

1. К проекту пользовательского интерфейса подключен PBC, использующий библиотечные PBC

2. Библиотечный PBC имеет проект интерфейса в Дизайнере пользовательского интерфейса, опубликованный как библиотека

3. Веб-компоненты библиотеки зарегистрированы в публичном Реестре компонентов (opens in a new tab)

4. Выполнены настройки ui-библиотеки для подключения её в прикладной проект

5. В проекте интерфейса прикладного PBC настроены свойства библиотеки и/или ее веб-компонента (-ов)

Способы подключения библиотечных веб-компонентов в проект

Доступно 2 способа подключения в проект веб-компонентов библиотечных PBC:

1. Вручную - при создании страницы по Q.Archer

2. Автоматически - по событию публикации паспорта PBC

Автоматическое подключение библиотечных веб-компонентов

Автоматическое подключение библиотечных компонентов выполняется по событию публикации паспорта прикладного PВС - qdpbc-pbc-passport-version-event.

Чтобы автоматически добавить в проект веб-компоненты библиотечных PBC, выполните действия:

1. Перейдите к списку PBC в Q.Archer

2. Найдите свой PBC

3. Выберите пункт меню Библиотечные PBC в меню кнопки Дополнительно

4. Добавьте библиотечный PBC

5. Опубликуйте паспорт своего PBC

Индикаторами успешного подключения библиотечных веб-компонентов в прикладной проект интерфейса являются следующие (в качестве примера показана библиотека Проект технологической платформы с веб-компонентом qhprjs):

Индикатор	Пример
В разделе Страницы проекта добавлена папка Библиотечные UI, содержащая страницы с подключенными веб-компонентами, предоставленными библиотекой
При открытии страницы с подключенным веб-компонентом (из папки Библиотечные UI) отображается библиотечный компонент. Обратите внимание: В интерфейс подгружаются только компоненты, опубликованные на стенд qwork. Если веб-компонент не опубликован, то будет выведена ошибка 502 Ошибка загрузки компонента
В меню проекта добавлена группа меню проекта интерфейса библиотечного PBC Важно: Меню должно быть предварительно настроено в проекте интерфейса библиотеки

Обратите внимание: если у прикладного PBC нет проекта интерфейса, то после подключения библиотечного PBC и публикации паспорта прикладного PBC проект интерфейса будет создан автоматически

Важно: права доступа к автоматически созданному проекту предоставляются руководителю команды, ответственной за прикладной PBC. Далее РК может выдать участникам своей команды необходимый набор прав на проект интерфейса

Настройка свойств библиотеки и веб-компонентов

Чтобы настроить свойства библиотеки и/или ее веб-компонентов для использования в вашем проекте, выполните действия:

1. Перейдите в раздел Библиотечные UI вашего проекта интерфейса

2. Нажмите кнопку Свойства библиотеки или Cвойства веб-компонента в строке библиотеки / веб-компонента, соответственно

2. В открывшемся сайдбаре укажите значения для свойств библиотеки/компонента

Важно: свойства могут содержать константы, значения которых определяет библиотека при описании схемы атрибутов. Значения констант в прикладном проекте доступны на чтение.

Пример настроек свойств веб-компонента:

Настроенные свойства библиотеки/веб-компонента отображаются в свойствах элемента "Библиотечный UI" в редакторе страницы ("Страницы" -> "Библиотечные UI" -> страница интерфейса)

При публикации / скачивании архива прикладного проекта интерфейса выполняется подключение библиотеки и ее артефактов (веб-компонентов и меню) в коде проекта:

Описание	Пример
Библиотека подключена в package.json(строка 45) в примере
Библиотека подключена в angular.json (строка 71 в примере)
Библиотечный веб-компонент подключен в .components.html
Значения свойств библиотеки/веб-компонента добавлены в endpoint.properties в abstract файле компонента
Меню проекта, включая меню библиотеки, добавлено в rootapp/assets/data/menu.ru.json