« Back to Development

Multiple Versions of jQuery

Introduction #

If you are using Liferay 6 (or later), the portal uses Alloy UI instead of jQuery, which means that you can use whatever version of jQuery you need for your custom developments.

If you are using Liferay 5.2.x, you may have noticed that Liferay uses jQuery 1.2.6. Upgrading liferay to use a new library may be hard. New versions of jQuery are not backwards compatible and several features (such as drag and drop) may break.

However, a nice solution is to keep liferay using jQuery 1.2.6 and make your custom portlets or themes use a newer version if needed.

Method #

The file in liferay which loads all the javascript files is html/common/theme/top_head.jsp. You can overwrite this file using a hook or the ext environment to match your needs.

The next snippets are not the exact code that should be pasted but several solutions that allow to have several jQuery versions in the same page:

Example #

You may need to remove the jquery version of liferay from this property in your portal-ext.properties: javascript.barebone.files=. You can see when these files are loaded in top_head.jsp. If we remove it from here, we will need to load it manually afterwards.

The following code would keep liferay with 1.2.6 (as it is the last loaded library), and would keep the newer version under the variable $jq instead of $ or jQuery. You could use jq in your portlets or themes refering to the newer library.

<script type='text/javascript' src='js/jquery_1.4.js'></script>  
<script type='text/javascript'>  
  
 var $jq = jQuery.noConflict(true);  
  
</script>  
  
<script type='text/javascript' src='js/jquery_1.2.6.js'></script>

$jq('.classname').hide() -- uses jQuery 1.4
jQuery(.'classname').hide() -- uses jQuery 1.2.6

If we need to use jQuery plugins which require a specific version of jQuery (different to 1.2.6) we should do the following:

  1. Load the jQuery library needed
  2. Load the plugin library which requieres a specific version of jQuery
  3. Load and execute a custom "noConflict" script

For example, if the plugin music.js requires jQuery 1.4, we could do the following:

<script type='text/javascript' src='js/jquery_1.4.js'></script>
<script type='text/javascript' src='js/music.js'></script>   
<script type='text/javascript'>  
  
 var $jq = jQuery.noConflict(true);  
  
</script>  
  
<script type='text/javascript' src='js/jquery_1.2.6.js'></script>

This mechanism stores the newer version of jQuery under the variable $jq and allows the portal to keep using $ and jQuery for the old version while the plugins can use the required versions too.

0 Attachments
47421 Views
Average (4 Votes)
The average rating is 4.25 stars out of 5.
Comments
Threaded Replies Author Date
well...its not running, not on my theme Vergil Theng Soo Tan July 22, 2010 3:21 AM
I'm newbie to Liferay. I have to work with... tremen _73 September 24, 2010 3:08 PM
Is this valid for 5.2.3 i cant find any... Anders Olme April 1, 2011 12:35 AM
Hi Anders, This is absolutely valid for 5.2.3.... Jonny Olliff-Lee May 4, 2011 2:12 PM
This is working great for me with two minor... Jonny Olliff-Lee May 4, 2011 2:15 PM
Hi, If I'm reading this correctly, if I'm... Chris Chan August 5, 2011 5:28 AM
Jonny, Does your custom var $jq =... Joseph Cook August 26, 2011 7:51 AM
Man, can´t do it... I tried everything in my... Marcus Abreu October 5, 2011 6:41 AM
Liferay ver. 4.2 with jQuery ver. 1.1.4... Bogus Lis December 23, 2011 2:54 AM
I checked the portal-ext.properties and there... Robert Cruz July 18, 2012 12:35 PM

well...its not running, not on my theme
Posted on 7/22/10 3:21 AM.
I'm newbie to Liferay.
I have to work with Liferay 5.0.1, that uses jQuery 1.1.4, but I would like to take advatange from a later version of jQuery.

What contents are supposed to be at custom noConflict script. It's referred at article but I don't know how to create it actually.
Posted on 9/24/10 3:08 PM.
Is this valid for 5.2.3 i cant find any references in top_head to jquery.
Posted on 4/1/11 12:35 AM.
Hi Anders,

This is absolutely valid for 5.2.3. What are trying to do? Overwrite the portal version of jQuery or just use a different version for particular portlets?
Posted on 5/4/11 2:12 PM in reply to Anders Olme.
This is working great for me with two minor changes:

var $jq = jQuery.noConflict(true); // I've altered the wiki page to reflect this

<script type="text/javascript" src="/html/js/jquery/jquery.js"></script> //The second change is a link to the portal version of the jQuery file.
Posted on 5/4/11 2:15 PM.
Hi,
If I'm reading this correctly, if I'm trying to overwrite the version for a particular custom portlet, I just include that snippet of code above in my portlet's jsp (obviously changing the music.js to whatever I need)?
Posted on 8/5/11 5:28 AM.
Jonny,
Does your custom var $jq = jQuery.noConflict(true); script need to be written exactly as you show here?

I've done that, and the other steps you suggest but can't get it to work. I still have conflicts.

Thx
Posted on 8/26/11 7:51 AM in reply to Chris Chan.
Man, can´t do it...

I tried everything in my portlet, but just can do it....I tried this:

<script type='text/javascript' src='js/jquery_1.4.js'></script>
<script type='text/javascript' src='js/music.js'></script>
<script type='text/javascript'>

var $jq = jQuery.noConflict(true);

</script>

<script type='text/javascript' src='js/jquery_1.2.6.js'></script>

Off course, some changes made ( imported the jquery that i wanted, etc...) but it won´t go...An i doing something wrong??
Posted on 10/5/11 6:41 AM.
Liferay ver. 4.2 with jQuery ver. 1.1.4
Succesfully loaded jQuery ver. 1.7.1 (with DataTable plugin ver. 1.8.2)
Unfortunately .bind() core method from jQuery 1.7.1 doesn't work.
Any advice?
Posted on 12/23/11 2:54 AM.
I checked the portal-ext.properties and there is no entry for javascript.barebone.files and javascript.everything.files, however I do see the reference in the top_js.jspf.

Since I do not see these entries I do not see a way to remove the reference to the jQuery 1.2.6 and manually add it to the portal_normal.vm file since I want the current jQuery library available to the entire theme this includes jQueyUI and additional libraries.

I tried many of the steps listed in this wiki and the referring page leading me here and no luck. I am assuming once I remove the code reference to the jQuery library used by Liferay 5.3 then I can manually add it after adding the version I want to use.

Should the script tags be added to the portal_normal.vm?
Posted on 7/18/12 12:35 PM.