jQuery forward compatibility layer for Zikula 1.4.x

[phaidon]

Starting position
Zikula 1.4 and all later version will use jQuery as standard. By technical reason there is no noconflict for prototype.js. This means we have to drop prototype.js and all prototype.js javascript in Zikula (core, modules, ...)

The problems

1. Because there is no big motivation to program in prototype anymore more and more modules are using jQuery. This means both frameworks (prototype.js and jQuery) has to be loaded.
2. IMHO the release of 1.4 is far away (IMHO more the year). The replacement of prototype scripts in Zikula core is a huge work and it is difficult because it is to be done as hole step. Partly steps are not possible.

My suggestion
Add a jQuery forward compatibility layer to Zikula 1.4

How will it work

1. There will be a possibility in the system settings to select the preferred framework (jQuery/prototype)
2. There will a jQuery check in pageaddvar. If prototype is activated as preferred framework nothing will happen. If jQuery is activated as preferred framework pageaddvar will check if there is a jQuery version of a script which should be loaded. For example if pageaddvar has to add xxx/test.js it will test if a xxx/test.jQuery.js is available. If a jQuery is available it will load this file otherwise it will load the original file.

Questions

1. Can I still use prototype if chosed jQuery as preferred framework.
   Yes jQuery will use (like now) noConflict. So a mixture is still possible. This is also valid for the other way around.
2. How can I provide a jQuery version for inline code?
   There are two possibilities: 1. By a smarty if or by using an external js.

Benefits of this solution

1. It will be possible to run 1.3.x without prototype loading.
2. We do the jQuery migration work of Zikula 1.4. already step by step in Zikula 1.3.x.

[phaidon]

@Drak, @jusuff

[phaidon]

I tested my suggestion with the system settings module. Here what I have done:

1. I made the changes I suggested on the top and I activate jQuery as preferred framework
2. I created jQuery version of admin_admin_ajax.js and settings_admin_multilingual

After that I could load the multilingual settings page without prototype and scriptaculous.

[jusuff]

I like this idea. But we should know that this will require a lot of work with every system module and replacing each and every script with jQuery version.

Working on 1.4 I've made jQuery versions of core javascript libraries. This could be the base for this layer.

[phaidon]

I like this idea. But we should know that this will require a lot of work with every system module and replacing each and every script with jQuery version.

Yes it is, but for 1.4 we have to do this work anyway. Prototype wont work anymore if you want to use jQuery with $.

We could even think about to do the migration step by step (1.3.6, 1.3.7, ...) and mark the jQuery option as experimental.

Working on 1.4 I've made jQuery versions of core javascript libraries. This could be the base for this layer.

Definitely. I saw you want to use underscore, modernizr, polyfills. I think this is a good base.

[ghost]

bump

[ghost]

Now we have seriously integrated jQuery/Bootstrap, are there any more thoughts or changed opinions now?

[craigh]

renamed from jQuery forward compatibility layer for Zikula 1.3.x to jQuery forward compatibility layer for Zikula 1.4.x

[craigh]

ping @jusuff @phaidon

[Guite]

IMHO this can be closed, since we have agreed about future JS directions and can use $ with the approaches described at https://github.com/zikula/core/wiki/Module-Development-Best-Practices#javascript--jquery

Please confirm or deny.

[phaidon]

What we can do is to convert all zikula helpers to jquery.
https://github.com/zikula/core/tree/1.3/src/javascript/helpers

I think @jusuff made already a nice beginning of that.

But the question is if we have time for it. @jusuff or what are your ideas?

[phaidon]

@jusuff it would be great if could talk about your plans and the time you want to invest.

[craigh]

ping @jusuff @phaidon what is the status here? Are you still willing/interested in doing any of this work? anytime soon? how should we proceed?

[craigh]

I've added the 'blocker' tag only as a means of promoting more immediate discussion/work. This may not truly be a blocker however.

[craigh]

ping @jusuff @phaidon any chance you will be working on this?

[phaidon]

I would to discard this idea.

I think the only good way to offer an prototype compatibility (without any problems) is to use jQuery noConflict.

IMHO I would use noConflict even in Zikula 2.0.0. This would allow to offer an prototype/zikula-helpers package.

So I suggest to close this topic.

[Guite]

I agree!
Does anybody have objections?

[craigh]

I agree also, but I wish someone would tackle the work of migrating existing needed scripts from prototype to jquery...

[cmfcmf]

👍

[Guite]

I can't promise anything at the moment, but I will try to proceed on #1214 soon.