JavaScript – How to Add CSS Class on Scroll

cssjavascriptscript

how to add class into div using on scroll in magento.

i have javascript like this

var $j = jQuery.noConflict();
$j(window).scroll(function() {    
    var scroll = $j(window).scrollTop();

    if (scroll >= 100) {
        $j(".page-header").addClass("header-bar");
    } else {
        $j(".page-header").removeClass("header-bar");
    }
});

that javascript will add or remove header-bar class from div with page-header class in it.
it look like this
<header id="header" class="page-header">
will become <header id="header" class="page-header header-bar">if i scroll down the page.

I tried using single html file, it is working perfectly, but then when i apply it in magento, it is not working, but no error message displayed.

The way i apply it into magento is like this:

First, i put that javascript into one file named header-effect.js and i store the file in skin\frontend\rwd\default\jsfolder.
After that, i add header-effect.js in page.xml <action method="addItem"><type>skin_js</type><name>js/header_effect.js</name></action>

I clear magento cache, refresh the page, scroll down the page but nothing is happen, i check page source and header-effect.js is loaded.

Am i doing it correctly?

Best Answer

For common Jquery errors, check if following steps are carried out:

Have you checked the console of your browser for any errors that might have occured.
Magento does not include jquery by default. Have you included it?
Magento requires jquery.noconflict script to be added at the end of the jquery scripts. This stops the conflict between jquery and magento's default prototype.
After including jquery.noconflict, I recommend not using the "$" sign for accessing jquery variables. Try using jQuery instead of $ everywhere.

Related Solutions

Magento – calling css using layout xml

You have an error in your xml, the <layout> tag at the end should be closed, but I will assume that it's a copy/paste mistake and that is not the problem

Your problem is here:

<default>
    <reference name="root">
        <block type="core/template" name="page_head" output="toHtml" template="page/html/head.phtml" />
        <action method="addCss"><stylesheet>css/normalize.css</stylesheet></action>
    </reference>
</default>

What you are doing is:

Referencing the root block in all pages, adding to it a block of type core/template that is using the page/html/head.phtml as its template.
Calling the addCss method of the page/html block (since the root is of that type if you look in the page.xml layout file)

What you should be doing is referencing the head block as the addCss function is in that one.

Now before answering your main question, I would like to put out a few remarks:

It is my understanding from reading the tutorials that Magento will load the default handle and apply to all the pages in this .xml file.

This is somewhat true, except that anything in the <default> handle, will applied website-wide, not just for pages of that particular layout file.

which class is used to load action method="addCss"? (I have looked in various Mage/Core/Block folders)

If you look at the page.xml file, you can find it. In fact there are 2 methods to add CSS files, addCss and addItem

<block type="page/html_head" name="head" as="head">
    <action method="addCss"><stylesheet>css/styles.css</stylesheet></action>
    <action method="addItem"><type>skin_css</type><name>css/styles-ie.css</name><params/><if>lt IE 8</if></action>
    <!-- etc. -->
</block>

From the type of the block, page/html_head, you would be able to figure out that the block is Mage_Page_Block_Html_Head. (It's in the format of module/path)

how do I set up the .xml file to add css to the pages in my module?

Since you need the css to be ONLY in you module's pages, you cannot put it in the <default> handle. As it would be loaded in all pages throughout the website.

But what you can do, is create your own "default" handle, and make all other handles "extend" it.

So using all that info, this is how your XML would look like:^tl;dr

<layout>
    <!-- First we create the default handle that should be applied to all
         of the module pages in this layout file-->
    <user_register>
        <reference name="head">
            <!-- There is no need to reference the root handle, we just
                 reference the head handle and call the addCss method -->
            <action method="addCss"><stylesheet>css/normalize.css</stylesheet></action>             
        </reference>
    </user_register>
    <!-- The next handle will match the BASE_URL/user/register/form path -->
    <user_register_form>
            <!-- This is the tag which "extends" the user_register handle-->
            <update handle="user_register"/>
            <block type="core/template" name="prefcentre_regform" output="toHtml" template="ps/prefcentre/signup.phtml" />
    </user_register_form>
</layout>

where do I need to locate my css for magento to find them?

Since you used css/normalize.css as the path for the CSS file, it should be located at frontend/default/default/css and not inside a subfolder.

Magento – Basic question: How to add javascript functionality to a page

Welcome to Magento.SE!

Because this is theme-related, you would place it in the skin/js folder in your theme's path; something like:

[mage-root]/skin/frontend/[yourpackage]/[yourtheme]/js/jquery.waypoints.js

Next you'll need to add some layout xml to shove this into your theme; possibly in your theme's layout/local.xml file; this is how you achieve the 'targeting' you were asking about earlier:

<catalog_product_view>
    <reference name="head">
        <action method="addItem"><type>skin_js</type><name>js/jquery.waypoints.js</name></action>
    </reference>
</catalog_product_view>

If you want layout xml for sitewide, change catalog_product_view to default.

I recommend you look into jQuery Waypoints, my personal favorite sticky-header JS that does so much more.

Best Answer

Related Solutions

Magento – calling css using layout xml

Magento – Basic question: How to add javascript functionality to a page

Related Topic