O'Reilly

“Top” Watermark Using MooTools

By on  

Whenever you have a long page worth of content, you generally want to add a "top" anchor link at the bottom of the page so that your user doesn't have to scroll forever to get to the top. The only problem with this method is that I may want to get to the top of the page from somewhere in the middle. Using MooTools, we can create a "top" link as a watermark that follows the users down the page.

The XHTML

<a href="#top" id="gototop" class="no-click no-print">Top of Page</a>

Place this anywhere inside the page that you would like.

The CSS

#gototop { display:none; position:fixed; right:5px; bottom:5px; }

This code positions the element in a fixed position so it always stays in the same spot.

The MooTools JavaScript


/* smoothscroll - scroll smoothly to the top*/
new SmoothScroll({duration:500});

/* go to top after 300 pixels down */
var gototop = $('gototop');
gototop.set('opacity','0').setStyle('display','block');
window.addEvent('scroll',function(e) {
	gototop.fade((window.getScroll().y > 300) ? 'in' : 'out')
});

The code is surprisingly short. Of course we use SmoothScroll to make the transition smoothe. You may adjust the pixel trigger amount however you'd like. Unfortunately the above code doesn't work in IE6.

The IE Fix

/* go to top */
var gototop = $('gototop');
gototop.set('opacity','0').setStyle('display','block');
window.addEvent('scroll',function(e) {
	if(Browser.Engine.trident4) {
		gototop.setStyles({
			'position': 'absolute',
			'bottom': window.getPosition().y + 10,
			'width': 100
		});
	}
	gototop.fade((window.getScroll().y > 300) ? 'in' : 'out')
});

I like this method so much that I use it on my website.

Shouldn't this be a plugin?

Don't worry -- ScrollSpy is coming soon enough. :)

Track.js Error Reporting

Upcoming Events

Recent Features

Incredible Demos

  • CSS Text Overlap

    One of the important functions of CSS is to position elements. Margin, padding, top, left, right, bottom, position, and z-index are just a few of the major players in CSS positioning. By using the above spacing...

  • CSS Rounded Corners

    The ability to create rounded corners with CSS opens the possibility of subtle design improvements without the need to include images.  CSS rounded corners thus save us time in creating images and requests to the server.  Today, rounded corners with CSS are supported by all of...

Discussion

  1. Alelo

    hi, realy nice but the ie fix doesnt work right in IE8.0.6001(the newest Ie8 version) its comes but the “absolute” seems to be wrong, shouldnt it be position”fixed”?

  2. wonderfull… i m making an agenda in mootools (moogenda ;) ) where i have a diary for week or day that is very long… i think i’ll add this script tonight asap. thank you for the suggestion.

    Nunzio Fiore

  3. Santiago

    Very interesting effect indeed!
    It didn’t work for me in IE 7 though, it stay in the same place, doesn’t get the new height of the window, maybe because you forgot to add the “px” subfix to the bottom and width attributes in the css?

    I don’t have time right now to test it in my own, but I’ll probably do it when free ;)

    @Alelo:
    IE, at least until the 7 version, didn’t support at all position:fixed;, so in IE we’ll need a fix, in other words, need to change it’s position with javascript according to the window position.

    Cheers!

  4. anonymous

    Nice, since I just started to learn Mootools.
    But couldn’t we achieve the same effect with some css and position-fixed or background-attachment?
    What do u think?

  5. Guillermo Rauch

    Another trick would be checking that Window getScrollHeight() is larger than getHeight() to fade in the element.
    I also recommend using Element.Pin from the upcoming mootools-more

    http://github.com/anutron/mootools-more/blob/50f23f10f0de3bb8e851486e43028c9d973ce97e/Source/Element/Element.Pin.js

  6. seems that you have been peeking at my blog ;)
    http://blog.gonchuki.com/archives/usability-101-adding-a-global-back-to-top-to-your-site/

    You should take a look at the study we made back in 2007 about how much scroll is needed before we can confidently show the “back to top” element.

    btw, use Browser.Engine.trident4 if you want to isolate ie6, or use a CSS2 selector like we did back then to completely ignore ie6.

  7. IE position is not fixed

  8. Updated guys. The “trident4″ update was the golden gem for IE7.

  9. RedTreys

    Very nice.
    Any chance that you (or anyone else who would like to jump in) could offer its equivalent using jquery?

  10. I’ll add that to the to-do list RedTreys. Thank you!

  11. Rodney

    Thanks David, just the info I needed.
    Thanks again.

  12. How do i use this code with wordpress?

  13. Nils

    How to change the code making it work with mootools 1.11?

  14. Emil

    Like Nils, I’d like to know how the code looks like for mootools 1.11

  15. What’s to do that it work’s with mootools-1.2.3.1-more.js
    Updating this

    var go = document.id('gototop');
    

    doesn’t work.
    any idea
    thx

  16. Ana

    Yeah! Very nice post! Thanks a lot for this…

    Unfortunately someone stole your WHOLE post:
    http://adilkhan116.posterous.com/top-watermark-using-mootools

    Keep going,
    Ana

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!

Recently on David Walsh Blog

  • Generating Alternative Stylesheets for Browsers Without @media

    If your CSS code is built with a mobile-first approach, it probably contains all the rules that make up the "desktop" view inside @media statements. That's great, but browsers that don't support media queries (IE 8 and below) will simply ignore them, ending up getting the...

  • Serve a Directory with PHP

    Many developers have a giggle at PHP, even looking down at the language, but let's be honest:  most of our blogs are powered by it (WordPress) and it's a great language to dabble around with.  I cut my teeth on PHP, though I prefer to avoid PHP these days. But...

  • Tips you can Use to Build an Excellent eCommerce Experience

    There are many reasons to build a good eCommerce experience if you are planning to build an eCommerce website. Visitors can place items in their cart and leave your site without making a purchase. In fact, three out of every four of them will do so....

  • OSCON: Live Stream

    O'Reilly's OSCON is upon us and I'm super excited to share with you a live stream of OSCON keynotes, courtesy of O'Reilly! Check back here every morning this week to get a sneak peek at the best conference in the open source community! Thank you...

  • OâReilly Velocity Conference â New York

    My favorite front-end conference has always been O'Reilly's Velocity Conference because the conference series has focused on one of the most undervalued parts of client side coding:  speed.  So often we're so excited that our JavaScript works that we forget that speed, efficiency, and performance are just as important. The next Velocity...