Banner jQuery Easy

Warning There will be no conflict resolution until jQuery is enabled.

Enabling jQuery will trigger several actions. By default (before enabling/modifying advanced options), the plugin will:

  • look for library duplicates (jQuery, Migrate, jQuery UI or jQuery Mobile) in <script> tags,
  • look for stylesheet duplicates (for jQuery UI and jQuery Mobile) in <link> tags,
  • look for no conflict scripts and declarations,
  • delete those scripts, stylesheets and declarations,
  • replace the deleted libraries with the ones that you have selected,
  • add a single no conflict code script,
  • put all scripts in the correct order, alongside all others scripts of the treated page.
Add/Fix jQuery
No selection use the plugin without adding jQuery libraries, removing duplicate libraries or resolving jQuery conflicts
jQuery jQuery
replace the jQuery library and scan for jQuery issues
jQuery + jQuery UI jQuery + UI
replace jQuery and jQuery UI libraries and scan for jQuery and jQuery UI issues
jQuery + jQuery Mobile Profiles jQuery + Mobile
replace jQuery and jQuery Mobile libraries and scan for jQuery and jQuery Mobile issues

Note if jQuery UI or jQuery Mobile are not already located in the code source of your page, then you probably do not need it.

jQuery jQuery

(learn about jQuery)
Version
  • X load the library version X from the Content Delivery Network (CDN)
  • local use a specific file added by you on the server
  • Joomla! 3 Joomla! framework use the library packaged with Joomla (local)
Note jQuery v2+ does not support Internet Explorer 6, 7 and 8. Use only if you are certain you do not need support for these browser versions.
Profiles slim versions are available.
Sub-version When using versions 1.9 and over, the Google CDN asks we specify which release of that milestone is actually requested.
Prior to v1.9, the latest release of each milestone is used by default. But one can still specify a sub-version.

Example 2 where 2 is the last number in 1.9.2 when selecting the version 1.9.x

Local path The path to the local file when using the local version option.

Example /libraries/jquery/v1.7/jquery.min.js

Migrate version Use in conjunction with jQuery libraries v1.9 and over. It garanties older scripts created for jQuery remain compatible with the latest versions of the library.
  • X load the Migrate script version X from the jQuery CDN
  • local use a specific file added by you on the server
  • Joomla! 3 Joomla! framework use the script packaged with Joomla
Note Do not use Migrate when using jQuery prior to v1.9.
Migrate local path The local path to the jQuery Migrate plugin

Example /libraries/jquery/jquery-migrate-1.2.1.js

jQuery User Interface jQuery UI

(learn about jQuery User Interface)
Version
  • X load the UI library version X from the Content Delivery Network (CDN)
  • custom/local use a specific file added by you on the server
  • Joomla! 3 Joomla! framework use the UI library packaged with Joomla (local)
Sub-version When using versions 1.9 and over, the Google CDN asks we specify which release of that milestone is actually requested.
Prior to v1.9, the latest release of each milestone is used by default. But one can still specify a sub-version.

Example 2 where 2 is the last number in 1.9.2 when selecting the version 1.9.x

Custom/Local path The path to the local or custom file when using the custom/local option.
The jQuery UI file can be the full blown UI library or a custom one created at the jQuery UI website.

Example /libraries/jquery-ui/v1.8/jquery-ui-custom.min.js

Theme Set the UI theme (or skin) that will be used in conjunction with the jQuery UI library. Themes are not always required. Note The Joomla! framework does not package a theme for jQuery UI (the library has been customized and does not require skins). Therefore do not load a theme when using the jQuery UI library packaged with Joomla.
Warning Since jQuery UI v1.10.2, the base theme is not available anymore. Use another skin or you will end up with errors on the page. It has been re-introduced in jQuery UI v1.12.0.
Custom/local theme path The path to the custom or local CSS file.
Get or customize skins at the ThemeRoller UI ThemeRoller website.
Note Images are usually associated with a skin. Wherever the path of your file is, add a images/ folder containing those images.

Example /libraries/jquery-ui/v1.8/jquery-ui.css

Profiles

jQuery Mobile jQuery Mobile

(learn about jQuery Mobile)
Version
  • X load the library version X from the Content Delivery Network (CDN)
  • local use a specific file added by you on the server
Note jQuery Mobile is compatible with jQuery v1.8 and over
Local javascript path When using the local option, set the path to the local javascript (.js) file

Example /media/jquerymobile/v1.4/jquery.mobile-1.4.0.min.js

Local stylesheet path When using the local option, set the path to the local stylesheet (.css) file

Example /media/jquerymobile/v1.4/jquery.mobile-1.4.0.min.css

Theme Set the mobile theme that will be used in conjunction with jQuery Mobile.
  • default select if the local stylesheet already contains the skin
  • custom use file(s) added by you on the server
Custom theme path(s) The path to the custom skin stylesheet(s). Customize skins at the ThemeRoller Mobile ThemeRoller website.

Example /media/jquerymobile/themes/my-custom-theme.css

Additional modifications

The following settings work in conjunction with the Add/Fix jQuery value. They will have no effect if the Add/Fix jQuery value is set to No.

Replace when unique Replaces the jQuery/jQuery UI libraries and/or jQuery UI CSS with the plugin’s choices even when there is only one instance of those present on the page
Add when missing Adds the jQuery/jQuery UI libraries and/or jQuery UI CSS to pages that do not have jQuery on them
Ignore scripts Makes sure the scripts listed remain on the page and are not stripped out by the plugin (some file names are built in such a way they can be mistaken for a jQuery library). One script per line.
Note Joomla 3 The script file media/jui/js/chosen.jquery.min.js is added by default because it is commonly used.

Example /js/wanted_script.min.jquery.js

Strip no conflict code Removes all no conflict scripts and declarations by default.
Will get rid of jQuery.noConflict(), $.noConflict(), jQuery.noConflict(true), $.noConflict(true)
Add no conflict code
  • No Mostly used when jQuery is the only library loaded on the page.
  • Thru script declaration Adds jQuery.noConflict(); as visible script in <head>.
  • Thru script Default Adds the jquerynoconflict.js script file right after the jQuery script file. It ensures the jQuery scripts use jQuery rather than $, no matter if another library that could conflict with it is loaded before or after jQuery.
Fix document ready Replaces all occurrences of $(document).ready(function() or $(document).ready(function($) with jQuery(document).ready(function($).
Using jQuery in the statement is required when using no conflict

The following settings are independent from the Add/Fix jQuery option.

Caption
Disable Captions Gets rid of JCaption.
Note Since Joomla! 3.2, the caption script is a jQuery script.

Note Using sub-versions is useful for caching the library files for a year and therefore optimize website loading times. Find more information at the BucketSoft blog.

Note The plugin will sometimes remove the wrong scripts when looking for jQuery libraries. For instance:

  • …searchtools.jquery.min.js will be removed, wrongly identified as a jQuery library,
  • …jquery.searchtools.min.js will not be removed, rightly assuming this is a jQuery plugin.

When a library has been wrongly deleted (easily identified if you are using the reporting tool or comparing the source code before and after enabling the plugin), use the Ignore scripts option to force the plugin to ignore the script in its search for jQuery libraries.