Use custom JavaScript

This topic discusses how to use custom JavaScript components with the components provided by Magento or custom replacement implementations.

We strongly recommend that you do not change the source code of default Magento components and widgets. All customizations must be implemented in custom modules or themes.

Add a custom JS component

To add a custom JS component (module), take the following steps:

  1. Place the custom component source file in one of the following locations:
    • Your theme JS files: <theme_dir>/web/js or <theme_dir>/<VendorName>_<ModuleName>/web/js. In this case the component is available in your theme and its child themes.
    • Your module view JS files: <module_dir>/view/frontend/web/js. In this case, the component is available in all modules and themes (if your module is enabled).
  2. Optionally, in the corresponding module or theme, create a requirejs-config.js configuration file, if it does not yet exist there and set path for your resource. The RequireJS configuration file can be placed in one of the following locations:

    • Your theme: <theme_dir>
    • Module within your theme: <theme_dir>/<module_dir>
    • Your module (depending on the needed area - base, frontend, adminhtml): <module_dir>/view/<area>

Replace a default JS component

To use a custom implementation of an existing Magento JS component:

Place the custom component source file in one of the following locations:

  • Your theme JS files: /web/js
  • Your module view JS files: <module_dir>/view/frontend/web/js

Create a RequireJS configuration file requirejs-config.js, having specified the following:

1
2
3
4
5
6
7
var config = {
  "map": {
    "*": {
      "<default_component>": "<custom_component>"
    }
  }
};
  • <default_component>: the name of the default component you replace
  • <custom_component>: the name of the custom component

For example, if you want to use a custom navigation-menu.js script instead of the default menu widgets, your requirejs-config.js should contain the following:

1
2
3
4
5
6
7
8
var config = {
  "map": {
    "*": {
      "menu": "js/navigation-menu",
      "mage/backend/menu": "js/navigation-menu"
    }
  }
};

Place your requirejs-config.js file in one of the following directories (according to the location of your custom script, see step 1 of this procedure):

  • Your theme files: <theme_dir>
  • Your module view files: <module_dir>/view/frontend

This way, your custom JS component is used instead of the Magento component in all entries all over the frontend area.

Extend a default JS component

You can add a custom JS component/widget, which will extend a default Magento component/widget.

Extend Magento widget

To extend a default Magento jQuery widget, create <your_widget_name>.js with contents similar to the following:

1
2
3
4
5
6
7
8
9
10
11
define([
  'jquery',
  'jquery-ui-modules/widget', // use individual jQuery UI component if your widget is for frontend or base areas
   // 'jquery/ui', // use all 'jquery/ui' library if your widget is for adminhtml area
  'mage/<widget.name>' // usually widget can be found in /lib/web/mage dir
], function($){

  $.widget('<your_namespace>.<your_widget_name>', $.mage.<widget.name>, { ... });

  return $.<your_namespace>.<your_widget_name>;
});

Where the following notation is used:

  • <your_namespace>.<your_widget_name> - the name of your custom widget. According to the jQuery widgets naming convention, this value must contain a namespace and name.
  • mage.<widget.name> - the name of the Magento widget that you extend.

All jQuery UI components for frontend and base areas are located in lib/web/jquery/ui-modules dir. They can be used in JS widgets by jquery-ui-modules path mapping like jquery-ui-modules/widget and jquery-ui-modules/slider. Using individual jQuery UI components instead of the monolithic jQuery UI library improves storefront performance.

For information about initializing your custom widget in a .phtml template, see the JavaScript initialization topic.

Extend a default Ui component

To extend a default JS Ui component, your custom script must contain the following:

1
2
3
4
5
6
7
8
9
10
define([
  '<component_path>'
], function(<component_alias>){

  return <component_alias>.extend({

    defaults: { ... }, // properties with default values
    ... // methods of your component
  });
});

Where the following notation is used:

  • <component_path>: path to the default component that you extend
  • <component_alias>: variable containing the default component that you extend

For example, Filters.js script extends the default filters.js:

1
2
3
4
5
6
7
8
9
10
define([
  'Magento_Ui/js/grid/filters/filters'
], function(Filters){

  return Filters.extend({

    defaults: { ... }, // properties with default values
    ... // methods of your component
  });
});

For information about initializing your custom JS component in a .phtml template, see the JavaScript initialization topic.

If you need to enable the loading of default Magento JS components and widget initialization on a certain stage, add the following code in your JS script:

1
$(mage.apply);

Related topics