Модули
Last updated
Last updated
Одна из наиболее эффективных концепций Apeekflow — Модули. Модули Apeekflow — Приложения, которые могут быть включены и повторены в других приложениях. Вы можете вставить модуль в приложение или другие Модули (в остальной части этого документа они называются внешними приложениями), и они будут функционировать как единый компонент. Кроме того, Модули могут быть встроены в другие веб-приложения!
При создании приложения вы хотите повторно использовать набор компонентов и запросов в разных приложениях. Представьте себе карточку профиля пользователя. Профиль, изображение, имя, контакты. Если вы создадите эти элементы внутри Модуля, вы сможете интегрировать их во все другие приложения, поскольку это будет единый компонент.
Выберите Создать > Модуль в правом верхнем углу страницы администратора, чтобы перейти в редактор модулей.
При редактировании Модуля или Приложения нет никаких отличий, кроме настроек Модуля. Размещение компонентов и запросов к данным выполняется так же, как и в редакторе Приложений. Вы можете вставлять компоненты и создавать запросы так же, как в обычном процессе создания приложения.
В редакторе Модулей вы можете изменить размер Модуля, перетащив правый нижний угол до желаемого размера по умолчанию. Имейте в виду, что экран в Редакторе не отображает реальный размер Модуля по горизонтали, поскольку этот размер определяется в Приложении, в котором размещен Модуль.
Переключите кнопку на Панели свойств, чтобы настроить масштабирование высоты компонента в соответствии с контейнером. Это работает только для компонентов с фиксированной высотой в модуле.
При редактировании приложения или модуля выберите Вставить > Расширения > Модули, чтобы отобразить Модули, к которым у вас есть доступ.
Затем перетащите модуль на холст, задайте входные параметры и измените стили на панели свойств Модуля.
Размер по горизонтали можно выбирать произвольно. Однако, Модуль внутри рассматривает размер ограничивающего прямоугольника как 100% от его размера по горизонтали.
Поскольку Модули могут быть встроены, они должны иметь возможность взаимодействовать с внешними приложениями или веб-сайтами. Существует четыре элемента, поддерживающих взаимодействие с Модулем.
Входные данные: динамические параметры, передаваемые в текущий Модуль из внешних приложений.
Выходные данные: набор данных, доступных для внешних приложений.
Методы: методы, доступные для внешних приложений. Например, вы можете определить Модуль с resetTitle метод, позволяющий внешним приложениям вызывать его для сброса названия Модуля.
События: события Модуля могут обрабатываться внешними приложениями. Например, вы можете определить событие с именем dataChanged, чтобы внешние приложения могли добавлять к нему обработчики событий, как только dataChanged событие запускается модулем.
Входные данные Модуля — это параметры, передаваемые Модулю из внешних приложений. Поддерживаемые типы ввода: данные, строка, число, массив, логическое значение и запрос. Первые пять — это типы данных. Выберите данные, чтобы не ограничивать их определенным типом данных. При выборе типа запроса вы можете передать запрос из внешних приложений и запустить его внутри Модуля. Затем вы можете ссылаться на входной параметр Модуля по его имени.
На вкладке Настройки (зеленая) нажмите +Добавить, чтобы создать новый ввод. Щелкните по вводу, чтобы переименовать его, и выберите тип данных.
Чтобы быстро проверить эффективность входных параметров при редактировании Модуля, вы можете воспользоваться функцией проверки входных данных. В редакторе Модулей выберите весь Модуль для проведения тестов с имитацией входных данных на панели свойств Модуля (синяя).
Выходные данные модуля — данные, предоставляемые приложению или другим Модулям. Вы можете просмотреть выходные данные Модуля в браузере данных и получить к ним доступ с помощью кода JavaScript в {{ }}. Затем вы можете проверить выходные данные Модуля и ссылаться на них в приложениях или других Модулях, использующих его.
Методы используются для вызова функций / действий в Модуле извне — из вашего приложения или веб-страницы, на которую вы внедряете Модуль.
На вкладке Настройки нажмите +Добавить, чтобы создать новый метод Модуля. Щелкните метод, чтобы переименовать его, и выберите действие.
При создании метода для Модуля вы не можете создавать входные параметры для этого метода и можете ссылаться только на параметры в рамках текущего Модуля.
При использовании Модулей вы можете вызвать метод Модуля двумя способами:
В разделе обработчики событий выберите Действие > Компонент управления, а затем выберите компонент и метод.
Используйте точечную нотацию в запросах JavaScript. Например,module1.clearAll() вызывает метод clearAll() или module1.
Вы можете имитировать вызов тестового метода в функции Method Test.
На вкладке Настройки нажмите +Добавить, чтобы создать новое событие Модуля. Щелкните событие, чтобы задать его название.
В следующем примере событие contentChange активируется при изменении содержимого любого поля ввода. Вы можете активировать его двумя способами:
В обработчиках событий обоих входных компонентов нажмите + Добавить, выберите Изменить в качестве события компонента и Инициировать событие Модуля в качестве действия и, наконец, выберите событие Модуля contentChange.
Используйте точечную нотацию в запросах JavaScript: contentChange.trigger().
Когда приложение использует Модуль, вы можете настроить, как текущее приложение реагирует на события этого Модуля. Например, в обработчиках событий module1, нажмите + Добавить и выберите событие Модуля contentChangeи действие Показывает уведомление.
В следующем примере проводятся тесты событий в разделе Тестирование событий.
Конечным пользователям автоматически предоставляется разрешение на просмотр Модулей в приложениях или других Модулях, для которых у них есть разрешения на просмотр. Если вы являетесь редактором и хотите использовать Модуль во внешних приложениях, вы должны, по крайней мере, выполнять функции просмотра этого Модуля.
Apeekflow хранятся архивные версии ваших модулей для удобства использования. Нажмите Предварительный просмотр > Публикация в правом верхнем углу. Управление выпусками Модуля аналогично управлению выпусками приложения. Подробную информацию смотрите в разделе История версий.
События используются для передачи сигналов из Модуля во внешние приложения, например для определенияorderPlaced OrderModified события для Модуля управления заказами. Вы можете добавлять и запускать события внутри Модуля и обрабатывать их с помощью внешних .
