Пример для обновленной версии виджетов

Author: rpiontik

src/widgets/README.md

@@ -3,7 +3,7 @@
 **Цель примера:** Познакомить с возможностями расширения представлений 
 стандартных сущностей.
 
-# Суть примера
+## Суть примера
 Создаются виджеты, которые встраиваются в представления Aspects и Components.
 
 В components встраиваивается виджет, демонстрирующий, кто зависит
@@ -16,6 +16,9 @@
 
 ![Реализацторы аспекта](./images/aspects.png)
 
+## Требования
+Верия платформы: > 2.4.4
+
 ## Файловая структура примера
 * entities - расширения сущностей
   * templates - шаблоны виджетов

src/widgets/entities/aspects.yaml

@@ -1,22 +1,43 @@
 entities:
   # Расширяем сущность "aspects"
   aspects:
-    # Инъектируем собственный виджет
-    widgets:
-      # Будем показывать расширенную информацию об аспекте
-      people: # Идентификатор виджета
-        # Название виджета
-        title: Люди
-        # Расположение
-        # < - слева
-        # > - справа
-        # = - Растянуть на 100%
-        align: "<"
+    presentations:
+      # Встраиваемся в основную перезентацию (т.е. она уже существует)
+      blank:
+        widgets:
+          # Добавляем собственный виджет
+          people: # Идентификатор виджета
+            # Название виджета
+            title: Люди
+            # Идентификатор презентации, которая будет использоваться в виджете
+            presentation: people
+            # В params можно передать дополнительные параметры
+            # презентации, которые будут доступны в перемнной $params
+            #params:
+            #  param1: Значение параметра 1
+            #  param2: Значение параметра 2
+            # Расположение
+            # < - слева
+            # > - справа
+            # = - Растянуть на 100%
+            align: "<"
+      # Добавляем собственную презентацию
+      # Будем показывать членов команды, ответсвенных за аспект
+      people:
+        # Контракт по параметрам представления в формате JSONSchema
+        params:
+          type: object
+          properties:
+            aspect:
+              title: Идентификатор аспекта
+              type: string
+          required:
+            - aspect
         # Тип документа шаблона
         type: markdown
-        # Шаблон  виджета
+        # Файл шаблона
         template: templates/people.md
-        # Данные для шаблона
+        # Источник данных
         source: >
           (
             $lookup(aspects, $params.aspect)

src/widgets/entities/components.yaml

@@ -1,15 +1,38 @@
 entities:
   components:
-    widgets:
-      # Будем показывать внешние зависимости от данного компонента
-      outside_links: # Идентификатор виджета
-        # Название виджета
-        title: Кто зависит от этого компонента
-        # Расположение
-        # < - слева
-        # > - справа
-        # = - Растянуть на 100%
-        align: "<"
+    # Расширяем презентацию сущности
+    presentations:
+      # Встраиваемся в основную перезентацию (т.е. она уже существует)
+      blank:
+        # Добавляем собственный виджет
+        widgets:
+          outside_links: # Идентификатор виджета
+            # Название виджета
+            title: Кто зависит от этого компонента
+            # Идентификатор презентации, которая будет использоваться в виджете
+            presentation: outside_links
+            # В params можно передать дополнительные параметры
+            # презентации, которые будут доступны в перемнной $params
+            #params:
+            #  param1: Значение параметра 1
+            #  param2: Значение параметра 2
+            # Расположение
+            # < - слева
+            # > - справа
+            # = - Растянуть на 100%
+            align: "<"
+      # Добавляем собственную презентацию
+      # Будем показывать внешние связи на данный компонент
+      outside_links: # Идентификатор представления
+        # Контракт по параметрам представления в формате JSONSchema
+        params:
+          type: object
+          properties:
+            component:
+              title: Идентификатор компонента
+              type: string
+          required:
+            - component
         # Тип документа шаблона
         type: table
         # Определяем заголовок таблицы