Joomla! Issue Tracker | Joomla! CMS #5257 - Remove jQuery dependency from core.js

Closed
4 Dec 2014
Medium
Build: staging
# 5257
Diff
phproberto:jquery-core

Success

Success The Travis CI build passed Details

User tests: Successful: Unsuccessful:

phproberto
30 Nov 2014

This solves #5254

Issue description

I was checking core.js and noticed that we have added there some jQuery code in functions:

Joomla.renderMessages
and
Joomla.removeMessages

They are mainly used on install and overrider but also third part developers can be using them.

We officially support jQuery & Mootools even being migrating to jQuery. Adding that code causes that developers that want to use only Mootools are forced to load jQuery.

So we have to convert them to plain JS.

How to test

As it's hard to test message rendering in installation & language overrides here is some code that you can use. You have to add this code before applying the patch and test it before and after the patch to be sure that it's working the same.

I will explain how to put testing code in the articles view ( administrator/components/com_content/views/articles/tmpl/default.php). Around line 54 add:

JText::script('ERROR');
JText::script('MESSAGE');
JFactory::getDocument()->addScriptDeclaration('
    jQuery(document).ready(function() {
        jQuery(".js-test").click(function(){
            var messages = {
                "message": ["Message one", "Message two"],
                "error": ["Error one", "Error two"]
            };
            Joomla.renderMessages(messages);
        });
        jQuery(".js-test-clear").click(function(){
            Joomla.removeMessages();
        });


    });
');

Then before line 66 (after the main container tag) add the buttons that will trigger the actions:

<a class="btn btn-success js-test" href="#">Render messages</a>
<a class="btn btn-danger js-test-clear" href="#">Clear messages</a>

You will see something like:

Clicking on the Render messages button should display the messages.
Clicking on the Clear messages button should remove the messages.

View with the messages loaded:

phproberto - open - 30 Nov 2014

jissues-bot - change - 30 Nov 2014

Labels

Added: ?

c73175a 30 Nov 2014

[imp] remove jQuery dependency from core.js

dgt41 - comment - 30 Nov 2014

@test success

When deleting the msgs we end up with a lot of white space, I guess this happens only in the test env?

a1536aa 30 Nov 2014

[fix] Chrome bug with innerHtml

phproberto - change - 30 Nov 2014

The description was changed

phproberto - comment - 30 Nov 2014

In fact it was a chrome bug :(

Thanks for testing it should work now.

dgt41 - comment - 30 Nov 2014

will retest in the morning

Fedik - test_item - 30 Nov 2014 - Tested successfully

Fedik - comment - 30 Nov 2014

test
works good

dgt41 - comment - 30 Nov 2014

@test success

wilsonge - comment - 30 Nov 2014

Can we remove the call to jQuery in JHtmlBehaviour::core(); as part of this then please?

dgt41 - comment - 30 Nov 2014

@wilsonge But JHtmlBehaviour::core(); is out in the wild and people might use it to load both core+jquery. We can introduce JHtmlBehaviour::joomla(); or something else for clean core.
My 2c on this

Bakual - comment - 30 Nov 2014

Can we remove the call to jQuery in JHtmlBehaviour::core(); as part of this then please?

If core.js doesn't need jQuery anymore, then remove the call to jQuery.

But JHtmlBehaviour::core(); is out in the wild and people might use it to load both core+jquery. We can introduce JHtmlBehaviour::joomla(); or something else for clean core.

Nah. JHtmlBehaviour::core(); is supposed to load core.js. It happens to depend on jQuery for now, but if developer depend on it loading jQuery, then they are wrongly doing that.
It's the same thing we have with MooTools. Developers should always load their dependencies and not trust that other code does that for you.

dgt41 - comment - 30 Nov 2014

@wilsonge @Bakual Removing https://github.com/joomla/joomla-cms/blob/staging/libraries/cms/html/behavior.php#L88 didn’t broke something, so I guess you are both right here!

98dfa68 30 Nov 2014

[imp] remove jQuery dependency from JHtmlBehavior::core()

phproberto - comment - 30 Nov 2014

Good catch @wilsonge :)

I think this is perfect now.

dgt41 - comment - 30 Nov 2014

@phproberto don’t commit this one yet… I am sending you a PR...

6f14905 30 Nov 2014

makes sure that jquery is called whenever needed

dgt41 - comment - 30 Nov 2014