https://github.com/michaelchadwick/jquery-news-list

jQuery plugin that transforms an HTML list into an auto-cycling slideshow
https://github.com/michaelchadwick/jquery-news-list

cycle javascript jquery news plugin

Last synced: about 16 hours ago
JSON representation

jQuery plugin that transforms an HTML list into an auto-cycling slideshow

• Host: GitHub
• URL: https://github.com/michaelchadwick/jquery-news-list
• Owner: michaelchadwick
• License: mit
• Created: 2014-07-09T08:28:29.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-07-05T20:36:12.000Z (over 2 years ago)
• Last Synced: 2023-03-29T20:15:25.046Z (over 1 year ago)
• Topics: cycle, javascript, jquery, news, plugin
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.textile
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

README

        
h1. News List

*News List* is a jQuery plugin that transforms a simple HTML group of news items into an auto-cycling slideshow that can also be manipulated manually to show an individual item.

h2. Usage

First, include the jQuery library, @jquery.newslist.js@, @newslist.css@ in your @@ tag:





Then create a simple HTML structure like so:



  


    
News item #1.

    
News item #2.

    
News item #3.

    
News item #4.

  

  






Finish by calling the newslist function on the outermost element:



  $("#newslist").newslist();




And huzzah, the magic is done.

h2. Options

* *itemsDiv*: the div containing the news items. Defaults to ".items".

* *item*: the class for the div containing an individual news item. Defaults to ".item".

* *controlsDiv*: the div where the control links for each news item will be created. Defaults to ".controls".

* *cycler*: is the auto-cycling of news items on? Defaults to "true".

* *hoverClass*: class for links that are active/on. Defaults to "on".

* *cycleSpeed*: how fast, in milliseconds, the news items should cycle. Defaults to "10000".

* *fadeSpeed*: how fast, in milliseconds, each new news item should fade in. Defaults to "1000".

* *maxLoops*: how many times all of the news items should loop. If null, will loop indefinitely. Defaults to "null".

* *leadZero*: should control links have a leading zero for numbers 1-9? Defaults to "false".