Using JQuery UI and Bootstrap togheter in the same web page

Ryan

9 years ago

In the past few months we've seen the Bootstrap framework became more and more popular among web developers. The reasons are fairly obvious, we're talking about a powerful CSS/JS enhancement library featuring a lot of useful stuff to build a responsive, mobile-friendly webpage fully compatible with every major browser/device. The most recent version of the framework (v3.3.1 by the time of this post) contains a lot of useful javascript plugin requiring JQuery v1.9.0 or higher in order to work: there's no doubt that some of these websites are also running JQuery UI.

These 2 frameworks are indeed able to work togheter, but we need to pay attention to at least two naming conflicts between them which need to be fixed in order to avoid JS errors and, most importantly, get them to work properly. We're talking about the tooltip and button plugins, which happen to exist in both of these libraries with the exact same name.

The Issue.

Let's take the tooltip plugin as an example. Open the address http://jqueryui.com/tooltip/ and look at the sample code - by clicking on the "view source" link - to see how the JQuery UI tooltip plugin actually works:

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>jQuery UI Tooltip - Default functionality</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.11.2/themes/smoothness/jquery-ui.css">
  <script src="//code.jquery.com/jquery-1.10.2.js"></script>
  <script src="//code.jquery.com/ui/1.11.2/jquery-ui.js"></script>
  <link rel="stylesheet" href="/resources/demos/style.css">
  <script>
  $(function() {
    $( document ).tooltip();
  });
  </script>
  <style>
  label {
    display: inline-block;
    width: 5em;
  }
  </style>
</head>
<br>

<!doctype html>

<head>

<title>jQuery UI Tooltip - Default functionality</title>

$(function() {

$( document ).tooltip();

});

</script>

<style>

label {

display: inline-block;

width: 5em;

}

</style>

</head>

<br>

The highlighted text shows a call to the tooltip function which, thanks to JQuery UI, is added at runtime to any JQuery object. Bootstrap does the exact same job, as shown in the official tutorial:

$('#example').tooltip(options)

1	$('#example').tooltip(options)

This nasty naming conflict prevents the plugins to work an might also generates some Javascript errors depending on the framework <script> references order inside the web page. For example, here's what you'll most likely get in your Javascript Console if Boostrap is inserted after JQuery UI and the latter's tooltip plugin is being used:

Uncaught TypeError: Cannot read property 'documentElement' of null

We get this message because the tooltip plugin provided by JQueryUI has a completely different - and hardly compatible - interface than the Bootstrap plugin sharing its name.

The Solution.

The best way to make the 2 libraries blend togheter and "constructively" fix the aforementioned naming conflicts is to use the not-so-well-known $.widget.bridge plugin, which allows us to re-define each previously assigned prototype function name. The plugin is already included inside the JQuery UI standard distribution package, so we won't add any additional stuff to our website. The usage is quite simple:

// Change JQueryUI plugin names to fix name collision with Bootstrap.
$.widget.bridge('uitooltip', $.ui.tooltip);
$.widget.bridge('uibutton', $.ui.button);

// Change JQueryUI plugin names to fix name collision with Bootstrap.

$.widget.bridge('uitooltip', $.ui.tooltip);

$.widget.bridge('uibutton', $.ui.button);

These commands need to be executed after the JQueryUI and before the Bootstrap js file references. In the following example we can see a full implementation example in the <head> block of a common webpage:

<html>
<head>
<title>My JqueryUI + Boostrap page</title>
<script type="text/javascript" src="cdn/or/local/path/to/jquery.ui.js"></script>
<script type="text/javascript">
// Change JQueryUI plugin names to fix name collision with Bootstrap.
$.widget.bridge('uitooltip', $.ui.tooltip);
$.widget.bridge('uibutton', $.ui.button);
</script>
<script type="text/javascript" src="cdn/or/local/path/to/bootstrap.js"></script>
</head>
<body>
[...]
</body>
</html>

<html>

<head>

<title>My JqueryUI + Boostrap page</title>

// Change JQueryUI plugin names to fix name collision with Bootstrap.

$.widget.bridge('uitooltip', $.ui.tooltip);

$.widget.bridge('uibutton', $.ui.button);

</script>

</head>

<body>

[...]

</body>

</html>

After you do this, the tooltip and button prototype methods will be univocally routed to the Bootstrap ones: those provided by JQuery UI will also be usable as long as we call them by using the new alias we gave them: uitooltip and uibutton.

References:
http://stackoverflow.com/a/27745464/1233379 (my answer on StackOverflow which kinda inspired this post).

Print Friendly & PDF Download