You are browsing the documentation for version 3.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get the updated information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Mediator Handlers

OroUIBundle declares some mediator handlers. It’s preferable to use indirect method execution with mediator.execute() in all components which follows Chaplin architecture.


Handler Name Description
retrieveOption Returns application’s initialization option by its name
retrievePath Removes root prefix from passed path and returns meaningful part of path
combineRouteUrl Accepts path and query parts and combines url
combineFullUrl Accepts path and query parts and combines full url (with root prefix)
changeURL Accepts route and options for Backbone.history.navigate, allows to change url without dispatching new route

See also

See oroui/js/app/application module for details.

Page Controller

Handler Name Description
isInAction Allows to detect if controller is in action (period of time between ‘page:beforeChange’ and ‘page:afterChange’ events)
redirectTo Perform redirect to a new location, accepts two parameters: object with location information and navigation options
refreshPage Reloads current page, accepts navigation options
submitPage Performs submit form action via save call for a model, accepts options object with packed in data

See also

See oroui/js/app/controllers/page-controller module for details


Handler Name Description
addMessage messenger.addMessage
showMessage messenger.notificationMessage
showFlashMessage messenger.notificationFlashMessage
showErrorMessage messenger.showErrorMessage

See also

See oroui/js/messenger module for details

Widgets (Widget Manager)

Handler Name Method Description
widgets:getByIdAsync widgetManager.getWidgetInstance Asynchronously fetches widget instance by widget id
widgets:getByAliasAsync widgetManager.getWidgetInstanceByAlias Asynchronously fetches widget instance its alias

See also

See oroui/js/widget-manager module for details


Handler Name Description
showLoading Shows loading mask
hideLoading Hides loading mask


Handler Name Description
layout:init Initializes proper widgets and plugins in the container
layout:dispose Removes some plugins and widgets from child elements of the container