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

Чтобы подключить ui-библиотеку к прикладному проекту через Дизайнер интерфейсов, необходимо выполнить следующие настройки в проекте интерфейса библиотеки:

• зарегистрировать проект интерфейса как ui-библиотеку

• настроить схему атрибутов для библиотеки (опционально)

• зарегистрировать веб-компоненты в публичном Реестре компонентов

• настроить схему атрибутов для веб-компонентов (опционально)

• настроить меню проекта интерфейса

Регистрация ui-библиотеки

Чтобы зарегистрировать проект как ui-библиотеку, выполните следующие шаги:

1. Откройте проект интерффейса, который хотите выпускать как ui-библиотеку

2. Перейдите в Настройки проекта -> Конфигурация библиотеки

3. Нажмите кнопку Зарегистрировать библиотеку

Настройка схемы атрибутов для ui-библиотеки

Для подключения ui-библиотеки в прикладной проект можно описать схему атрибутов (свойства) библиотеки, которые пользователь прикладного проекта сможет переопределить под свой проект (сервис).

Обратите внимание: При описании атрибутов существующих ui-библиотек используйте текущие системные наименования атрибутов. Для новых библиотек рекомендуем указывать системные наименования атрибутов в camelCase

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

1. Откройте проект интерффейса, который хотите выпускать как ui-библиотеку

2. Перейдите в Настройки проекта -> Конфигурация библиотеки

3. Нажмите кнопку Схема атрибутов

4. Опишите схему атрибутов в открывшемся интерфейсе

Пример схемы атрибутов приведен ниже

Регистрация веб-компонентов в публичном Реестре компонентов

Чтобы добавить веб-компонент в публичный Реестр компонентов, выполните шаги:

1. Откройте публичный Реестр компонентов (opens in a new tab)

2. Нажмите кнопку Добавить

3. Заполните свойства веб-компонента в сайдбаре добавления компонента

Важно: Если маршрут к компоненту должен формироваться динамически, укажите маршрут в виде prefix + динамическая часть маршрута, например: digital-app/:routeName

4. Нажмите кнопку Сохранить

Также добавить веб-компонент в публичный Реестр компонентов можно через проект интерфейса

Настройка схемы атрибутов для веб-компонента

Важно: Если у всех веб-компонентов библиотеки одинаковые свойства подключения, то такие свойства необходимо описать в схеме атрибутов библиотеки - свойства распространятся на все веб-компоненты библиотеки

Обратите внимание: Свойства service и component веб-компонента уже содержатся в endpoint компонента. Добавляйте эти свойства в схему атрибутов веб-компонента, только если обращение к компоненту будет выполняться через endpoint.properties

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

1. Откройте публичный Реестр компонентов

2. Выберите необходимый веб-компонент

3. Нажмите кнопку Схема атрибутов

4. Опишите схему атрибутов в открывшемся интерфейсе

Чтобы определить значение для константы, откройте атрибут на редактирование и укажите значение в поле Дефолтное значение

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

Настройка меню проекта интерфейса

После подключения библиотечного РВС к прикладному РВС меню проекта интерфейса библиотеки будет интегрировано в меню прикладного проекта.

Рекомендуем корректно настроить меню библиотеки, чтобы его можно было использовать в прикладном проекте.

Ответственность за настройку меню проекта-библиотеки несет команда проекта-библиотеки