Create a Simple News Scroller Using MooTools, Part I: The Basics

By  on  
News Scroller

News scroller have been around forever on the internet. Why? Because they're usually classy and effective. Over the next few weeks, we'll be taking a simple scroller and making it into a flexible, portable class. We have to crawl before we walk though; let's make a simple news scroller using MooTools.

The HTML

<div id="news-feed">
	<ul>
		<li><strong style="font-size:14px;">News Item 1</strong><br />Pellentesque habitant morbi...<a href="#">Read More</a></li>
		<li><strong style="font-size:14px;">News Item 2</strong><br />Pellentesque habitant morbi...<a href="/news/2">Read More</a></li>
		<!-- more.... -->
	</ul>
</div>

The HTML part is fairly simple: a list with numerous list items (news items) wrapped in a single DIV.

The CSS

#news-feed	 { height:200px; width:300px; overflow:hidden; position:relative; border:1px solid #ccc; background:#eee; }
#news-feed ul	{ position:absolute; top:0; left:0; list-style-type:none; padding:0; margin:0; }
#news-feed ul li { height:180px; font-size:12px; margin:0; padding:10px; overflow:hidden; }

Getting the CSS correct is very important for our simple scroller. The wrapper DIV must be positioned relative and the UL must be positioned absolutely. Each LI's height + padding/margin/border must be the same height as the UL itself.

The MooTools JavaScript

window.addEvent('domready',function() {
	/* settings */
	var list = $('news-feed').getFirst('ul');
	var items = list.getElements('li');
	var showDuration = 3000;
	var scrollDuration = 500;
	var index = 0;
	var height = items[0].getSize().y;
	/* action func */
	var move = function() {
		list.set('tween',{
			duration: scrollDuration,
			onComplete: function() {
				if(index == items.length - 1) {
					index = 0 - 1;
					list.scrollTo(0,0);
				}
			}
		}).tween('top',0 - (++index * height));
	};
	/* go! */
	window.addEvent('load',function() {		
		move.periodical(showDuration);
	});
});

The settings will be placed at the top of the code block, as always. Once the settings are defined, a function is created that scrolls from the current news item to the next news item. Once the scroller reaches the last news item, it scrolls back to the first one. Lastly, when the page has loaded, the directive to start the news scroller is given.

Creating a basic scroller is super simple. Look forward to future posts expanding the capabilities of our scroller, including creating a class and adding events.

Recent Features

  • By
    How to Create a Twitter Card

    One of my favorite social APIs was the Open Graph API adopted by Facebook.  Adding just a few META tags to each page allowed links to my article to be styled and presented the way I wanted them to, giving me a bit of control...

  • By
    Camera and Video Control with HTML5

    Client-side APIs on mobile and desktop devices are quickly providing the same APIs.  Of course our mobile devices got access to some of these APIs first, but those APIs are slowly making their way to the desktop.  One of those APIs is the getUserMedia API...

Incredible Demos

  • By
    Create a Dynamic Table of Contents Using MooTools 1.2

    You've probably noticed that I shy away from writing really long articles. Here are a few reasons why: Most site visitors are coming from Google and just want a straight to the point, bail-me-out ASAP answer to a question. I've noticed that I have a hard time...

  • By
    Create WordPress Page Templates with Custom Queries

    One of my main goals with the redesign was to make it easier for visitors to find the information that was most popular on my site. Not to my surprise, posts about MooTools, jQuery, and CSS were at the top of the list. What...

Discussion

  1. Continue, David… ;)

  2. Gabriel

    It suggest you stop the event when mouseover the item ^_^ , other than that… beautiful!!! hehe

  3. Can you please write up a JQuery equivalent?

  4. Jay

    One thing I dislike about looping carousel scrollers like this is the big scroll it makes when it goes from Item 9 back to Item 1. I suspect that it might be possible to circumvent that scroll by duplicating Item 1 next to Item 9, and then when it switches to the duplicated Item 1 (with a normal scroll), you replace the position with the original Item 1 (no animation). Seem possible?

  5. @Gabriel: Will keep in mind for the next post.

    @Brian Lang: Possibly.

    @Jay: Yep, I’ll add that to the list.

  6. Arian

    @David and Jay

    You might achieve that by cloning the UL, so you have 2 UL’s in the DIV

    Then, you can scroll nicely from 9 to 1… when you’re at #1 again, you put the first UL after the cloned one, and so on.

  7. @Arian: Continued cloning sounds inefficient. Should be able to just do a setStyle.

  8. Arian

    @David

    I didn’t meant continued cloning, but clone the UL once, and use setStyle, .inject(el,’after’) or something like you already mentioned

  9. I wish you see the jquery cycle? because its the same is and very easy

  10. elron

    thanks david!
    can you make another demo when the direction is down, left, or right?
    thanks.

  11. Nice work David!! Amazing like always. Just one thing.. dont work on IE8.

    I been looking for a rotator effect, like a wheel. Exist something like that in mootools?? (sorry my bad english)

    Thanks again!

  12. Works for me in IE8. What problem are you seeing?

  13. Now its working.. sometimes when I refresh the web, dont work or suddenly start… well.. I think could be the “amazing” browser.

    And about the wheel efect? some idea???

    Thanks!!!!

    • tomonto

      Yes, I got the same with you, I must refresh the web , it will works, but sometimes it doesnt work or suddenly start In IE 8 and IE 9.But it alway works in other browsers.

  14. Shahin

    As always great job. Can you give me hint how to add mouse over stop the event.

  15. Is there any way to make it scroll on horizontal way, or the other way around like vertical? I guess this might be great for a featured content scroller. Thanks for sharing!

  16. cesar delgado

    I M just a graphic designer with not too much programming knowledge, how this works? is this a simple copy paste that I can use in my dreamweaver? is that easy?

    Thanks a lot David

    Cesar

  17. elron

    @cesar delgado: its MooTools.

  18. tuxfede

    Good job!! I’m trying to implement this efect in a website, but I’would like that news where continuously scrolling in circles instead of going up to the first item. Also, it’s would be a good idea that the efect stop on mouseover. Sorry for mistakes, but I’m not English!.

    Thanks a lot.

  19. Belary

    Hi, David nice work
    but I tried many times to copy your code it still does not work in IE8

    :~(

  20. Hey David,

    I would second tuxfede’s requests of a “circular” scroller and a pause with onMouseEnter.

    If I figure it out, I’ll post it here!

    Thanks,
    Chris

  21. The script don’t works!

    See here and help me:
    http://andreahomepage.altervista.org/slide-news/index.php

  22. It doesn’t work… look and hel me, please!

    http://andreahomepage.altervista.org/slide-news/

  23. elron

    @Andrea: your link works for me… try to crtl+f5

  24. Yep, i change thed js code with the dojo!! thank again :)

  25. James

    Hi David

    Having some problems with this one, it doesnt seem to work in IE 8, it just does nothing, thats the code from this page and mootools 1.2.4,

    works in chrome etc

    really like the no nonsence approach of this and any help would be appreciated :)

    thanks in advance

    James

  26. Gary Corcoran

    Hi David,

    Testing this on a joomla site and I’m getting a “String contains an invalid character” code: “5” error? I’m guessing this is something to do with my mootools version (1.12) but I may be wrong?

    Also hate to be demanding with all the help on here but I was wondering how would I make the news items fade one to the next rather than slide?

    Thanks
    Gary

  27. tomonto

    Hi David,
    could you try to open the url (http://davidwalsh.name/dw-content/news-scroller.php) In IE8, Maybe something could be found. It doesnt work utill you refresh the web.

  28. How can I pause on MouseOver?

  29. Bassam

    what does it take to implement the fade instead of the scroolTo

  30. I have found a nice News Scroller using jQuery and it made my Day ! eeehhhaaaa !

    Check this below:

    http://codecanyon.net/item/wp-easy-news-scroller/4063270

    “WP Easy News Scroller” Plugin is a jquery based wordpress plugin which is used to show the wordpress news or relevant posts with various sliding effects and sixteen (16) different Themes. It can be integrated in the sidebar or footer area on your Blog or Website. WP Easy News Scroller Plugin adds latest news with Title, Image and Description. One can easily install and setup the plugin into the WordPress site.

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