Представление задач проекта

Слот project.issues.view добавляет представление в переключатель видов задач проекта. С его помощью можно показать отчет, диаграмму или другой интерфейс для задач, выбранных фильтром проекта.

Когда пользователь выбирает плагин, его интерфейс занимает область результатов. Панель фильтра остается доступной. Название представления берется из поля title в манифесте плагина.

Слот работает на полной странице проекта в настольной версии Трекера. В мобильной версии и боковой панели проекта он не используется. Для глобального списка задач предусмотрен отдельный слот issues.view.

Настройка слота

Создайте проект командой weavix create и выберите шаблон project.issues.view. В существующем проекте добавьте слот в slots.tracker манифеста:

{
  "slots": {
    "tracker": {
      "project.issues.view": [
        {
          "entrypoint": "index.html",
          "contextLevel": "full",
          "title": {
            "ru": "Мое представление проекта",
            "en": "My project view"
          }
        }
      ]
    }
  }
}

Это фрагмент манифеста: сохраните остальные обязательные поля вашего проекта. Укажите contextLevel: "full", чтобы получать фильтр задач. Уровень basic возвращает только { entityId: string }, где entityId — числовой идентификатор проекта из URL, переданный строкой.

После подключения плагина откройте раздел задач проекта и выберите представление с названием из манифеста. Его можно открыть из переключателя списка, календаря, Ганта или доски проекта. При выборе плагина Трекер переходит к списку задач проекта и использует фильтр этого списка. Отдельные настройки фильтров календаря, Ганта или доски в него не переносятся.

Подготовка и подключение плагина описаны в разделе Как подготовить плагин к публикации.

Контекст слота

SDK экспортирует типы ProjectIssueViewSlotContext, ProjectIssueViewFilter и ProjectIssueFilterValue:

type ProjectIssueFilterValue =
    | string
    | number
    | boolean
    | null
    | ProjectIssueFilterValue[]
    | { [key: string]: ProjectIssueFilterValue };

type ProjectIssueViewFilter = {
    filter: Record<string, ProjectIssueFilterValue>;
    order?: string;
};

type ProjectIssueViewSlotContext = {
    entityType: 'issues';
    projectId: string;
    filter: ProjectIssueViewFilter;
    groupBy?: string;
    tree?: boolean;
};

projectId — числовой идентификатор текущего проекта из URL, переданный строкой. Например, для /pages/projects/123/issues значение будет "123". Контекст не содержит полный объект проекта или массив найденных задач.

Поле slotContext.filter содержит условия примененного фильтра по параметрам:

Поле в slotContext.filter

Содержание

filter

Имена полей фильтра и их значения. Вложенные объекты и массивы сохраняют структуру условий

filter.project

Идентификатор текущего проекта, совпадающий с slotContext.projectId. Ограничивает выборку задач этим проектом

filter.keyOrSummary

Текст отдельного поиска, если он задан. Трекер уже добавил его в условия

order

Необязательная сортировка: например, +updated по возрастанию или -updated по убыванию

Поля groupBy (поле группировки) и tree (признак древовидного представления) необязательны и находятся на верхнем уровне контекста. Выражения QL2 доступны в контексте слота общего списка задач issues.view.

Например, для проекта 123:

{
  "entityType": "issues",
  "projectId": "123",
  "filter": {
    "filter": {
      "project": "123",
      "status": ["open"],
      "keyOrSummary": "error"
    },
    "order": "-updated"
  },
  "groupBy": "status",
  "tree": false
}

Получение и обновление контекста

В компоненте внутри TrackerPluginProvider вызовите useTrackerPluginContext:

const { slotContext } = useTrackerPluginContext<'project.issues.view'>('full');

Пока фильтр проекта не готов, slotContext может быть undefined. При смене проекта или изменении примененного фильтра хук получает новый контекст и обновляет компонент.