Important

You are browsing the documentation for version 4.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Security Support ends in January 2023. Read version 5.0 (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.

JavaScript

Javascript in OroCommerce has a modular architecture based on Chaplin and Backbone.

See also

JavaScript Frontend Architecture covers the client-side architecture of OroPlatform-based applications including OroCommerce.

This section provides configuration reference for the Webpack library to enable a modular structure of JS components in Oro applications.

JS Modules Definition

JS modules configuration file should be placed in the Resources/views/layouts/{theme_name}/config folder and named jsmodules.yml, for example DemoBundle/Resources/views/layouts/base/config/jsmodules.yml.

Entry point for Webpack build is oroui/js/app. But you can change it providing the same alias to the necessary entry point.

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# src/Acme/Bundle/DemoBundle/Resources/views/layouts/base/config/jsmodules.yml
shim:
    jquery:
        expose:
            - $
            - jQuery
    jquery.form:
        imports:
            - jQuery=jquery
map:
    '*':
        'jquery': 'oroui/js/jquery-extend'
    'oroui/js/jquery-extend':
        'jquery': 'jquery'
aliases:
    'jquery$': 'oroui/lib/jquery-1.10.2'
    'jquery-ui$': 'oroui/lib/jquery-ui.min'
    'oroui/js/app$': 'acmedemo/js/app'