Specifically with jQuery, there is a use for loading multiple versions of the library, even on a single page. I've just created a module that facilitates doing this - jQuery Multi.

jQuery Multi uses the Libraries API 1.x, and I'm trying to wrap my head around how this can use Libraries 2.x. It seems clear that Libraries specifies that only one version of a library can be loaded at one time. When the jQuery Libraries module is released, there will be a conflict with my module, where we both want to load from /libraries/jquery. I'm trying to solve that problem preemptively, but I'm having a hard time figuring how.

Any help or feedback woud be appreciated!


tstoeckler’s picture

The reason we only support one version at a time is that it is nearly impossible to predict which library will be loaded where.
If you could retrieve a list of pages which load version X and a list of pages which load version Y, then the problem would be lessened quite a bit.
But even then, you would come into cases, where you would have to load both libraries on the same page. But you can't do that, because that would lead to errors. So you would still have to implement some fallback mechanism in the dependants of the library. So the net win, seems to be near zero.

Love to hear your thoughts, though, I assume you have a different perspective. :)

tstoeckler’s picture

Just looked at jQuery Multi.

Not to discredit your effort over there (it does seem like the cleanest possible way to do that), but it really feels like a hack.

There's ongoing discussion about how this would work ideally in Drupal core in #1400748: Proposal for unified namespace organization (at the bottom). My personal (as in not official Libraries API maintainer) position is that the ideal way would be for a contrib project à la jQuery Update to provide newer versions of core scripts that work with newer jQuery versions. Then dropping those in together with the new jQuery wouldn't break anything. Since the core scripts have to updated anyway for the next Drupal version (e.g. Drupal 8.x contains a newer version of jQuery than Drupal 7.0), the maintenance effort should be managable.

goron’s picture

Thanks for your feedback tstoeckler.

  1. I see of course that loading two versions of a library usually would not be advisable or possible. This issue is specifically for jQuery, which has a built-in mechanism (the noConflict mode) that enables this. We would at least want Drupal/Libraries API to not be incompatible with that. Of course, you could always load it as a differently named library, but that doesn't seem like a good solution. So my primary question here is how that could be done through the Libraries API.
  2. I do see your point that it's a good idea to keep updating Drupal's core JS. But the fact is that doing this has taken too long in the past (take a look at the jQuery update issues for getting a version higher than 1.3 for D6), which can hold modules back from working with modern, up-to-date jQuery libraries/plugins that require a higher version of jQuery. So jQuery Multi aims to give those modules a way to get past that.
tstoeckler’s picture

Hmm... I guess something like that could in theory be supported by http://drupal.org/project/jquery
Not sure yet, though, how the implementation should be. Because we really do not want to open that door for anybody else...

tstoeckler’s picture

Hmm... I wonder if we had a Library class for all our business logic, that would allow jQuery to subclass that. That's of course highly theoretical, but it seems that would be the cleanest way to support such a custom logic?!

tstoeckler’s picture

Note that for 7.x-3.x we will actually strive for a class-based architecture, so like I said in #5, I assume this would be possible. I'm leaving this open for now, but in the long run, this will probably handled by http://drupal.org/project/jquery

Leeteq’s picture

Version: 7.x-2.x-dev » 7.x-3.x-dev
Category: support » feature
Priority: Normal » Major

Docs reference:
"Only one version of a library can be installed per site", at

This limitation means that many sites will continue to find themselves in the eternal dilemma of balancing the ideal mix of functionality with the hard reality of available stable/secure versions (even when mixed versions are already supported in jquery itself), as there will always be various libraries with their Drupal counterparts in different state of development. This is even more of a battle when also the external libraries and the jquery library itself is in constant development, adding support for new things while removing some old features. This situation is not likely to end at all.

IMO, it is therefore important to help and encourage Drupal administrators to choose stable Drupal module versions as much as possible, which means supporting the common situation where various modules and versions comes with their own dependency on specific jquery versions.

If not, this indirectly causes more Drupal sites to take the risk of running less secure/stable -dev versions whenever the only real alternative is to skip crucial functionality alltogether (or be forced to choose modules that are less suitable for their needs).

Moving to the 3.x branch as a feature request, and upping the priority tentatively.

Leeteq’s picture

Title: Possible to support two versions of a library loaded together (for jQuery)? » Provide support for more than one version of a library per site concurrently

More suitable title (for a feature request)..(?)

Leeteq’s picture

For reference (2010 issue): #719896: Add a hook_libraries_info()
("The UI (Libraries API admin page) would offer the option to choose/switch to which version would be used globally per site. Later on, we could have it so modules that work only with specific versions of a library override this global site setting in their settings page.")

tstoeckler’s picture

Title: Provide support for more than one version of a library per site concurrently » Allow to load more than one version of jQuery at a time

For the 3.x branch we are moving to an object-oriented approach that will allow us to override the default loading behavior (which is to bail out, if any version is already loaded) for jQuery in a sub-class, and in that way allow to load more than one version simultaneously. That will probably happen in the jQuery module, though. Also, just as a disclaimer, it is also quite a ways off, for now.

For now I have only ever heard this feature request when speaking about jQuery, so adjusting the title accordingly. In general, or as a default, I still think we need to enforce that only one version of a library exists at any time.

I am still leaving this as a feature request, as we should make sure that we allow jquery.module to implement this behavior in a sane way. I might mark it "normal" rather than "major" but can't decide on that right now, so leaving for now. :-)

sun’s picture

Righto. "Multiple versions in parallel" is definitely limited to front-end libraries, and out of those, only a handful support that concept in the first place.

I'm not exactly sure to which extent we can support this directly in Libraries API, since the entire idea is sorta detrimental to Libraries API (as well as Composer) in the first place -- the goal is to rely on a single library instead of multiple versions instead. I'm pretty sure that Composer doesn't support that concept at all and bails out with an error message along the lines of that conflicting dependency versions have been specified, so dependencies are not resolvable.