OXBOX Help

Структура вызываемого модуля

Базовая структура модуля представляет из себя следующий объект:

{ settings: {...}, components: { buttons: Array<{...}>, filters: Array<{...}> }, size: number, type: string, hook?: string }
  • settings - вариативный объект для дополнительных настроек конкретного модуля.

  • components - объект с свойствами buttons и filters. Подробнее о структуре в разделах [[Button]] и [[Filters]]. Большинство модулей рассчитаны на вариативный вывод кнопок действий и/или фильтров, если таковое логически оправдано.

  • size - размер модуля в контейнере контентной части. Принимает значения от 1 до 4.

  • type - тип модуля. Подробнее об этом ниже.

  • hook - ситуативное свойство. Необходимо для подключения автообновления модуля.

В системе используются модули следующих типов:

  • [[header]] - отображение заголовка страницы.

  • [[list]] - отображение списка в виде таблицы.

  • [[form]] - форма для отправки данных на сервер или отображения редактируемых данных. В большинстве случаев напрямую связан с модулем типа list.

  • [[info]] - имитация формы, но без возможности редактировать данные.

  • [[analytic_widgets]] - виджеты для отображения сводной информации по каким-либо данным (объем продаж, выручка, количество новых клиентов и т.п.).

  • [[roles]] - модуль используется для создания или редактирования уже существующих ролей для пользователей системы. Осуществляет предоставление доступов для взаимодействия с приложением.

  • [[schedule]] - расписание событий пользователей системы с возможностью создания новых/редактирования существующих событий в пределах рабочего графика.

  • [[tabs]] - вкладки, позволяющие формировать множество вложенных страниц.

  • [[Модули/Типы вызываемых модулей/Chat]] - чат для взаимодействия с другими пользователями.

  • [[mini_chat]] - урезанная версия модуля типа chat. Предоставляет возможность общаться в формате одного чата.

  • [[calendar]] - модуль для создания рабочего графика пользователя системы или создания простого кастомизированного события.

  • [[documents]] - форма создания документов с динамическими переменными.

  • [[funnel]] - список столбцов с событиями для быстрого изменения статуса. В контексте приложения используется для задач.

  • [[news]] - модуль для вывода новостной информации.

  • [[logs]] - список событий, идущих друг за другом. Используется для отслеживания изменений данных.

  • [[accordion]] - "сложенный" список документов. В приложении используется для отображения закрепленных за клиентом медицинских заключений или договоров.

  • [[day_planning]] - облегченная версия модуля schedule с возможностью просмотра или редактирования только собственных событий.

  • [[queue]] - модуль для отображения электронной очереди.

  • [[yandex_map]] - модуль для отображения на картах "Яндекс" переданных координат.

  • [[buttons]] - сжатый список кнопок для дальнейшего взаимодействия. Используется для вхождения на новый уровень вложенности, когда отображение прочей информации не требуется.

  • [[html_page]] - модуль для отображения вёрстки, переданной в виде строки.

  • [[mini_list]] - аналог модуля типа analytic_widgets. Отображение сводной информации, но в структуре, близкой к модулю типа list.

При передаче прочих типов задействуется информационная заглушка.

15 мая 2025