diff --git a/AUTHORS.txt b/AUTHORS.txt
index b2168655ee0..e4be5e747c4 100644
--- a/AUTHORS.txt
+++ b/AUTHORS.txt
@@ -28,3 +28,4 @@ Keith Wood (kbwood@virginbroadband.com.au)
Maggie Costello Wachs
Richard D. Worth (rdworth.org)
Jörn Zaefferer (bassistance.de)
+Kai Schlamp (schlamp@gmx.de)
diff --git a/README.md b/README.md
index 5c7d79a1335..3007bce7d3b 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,43 @@
[jQuery UI](http://jqueryui.com/) - Interactions and Widgets for the web
================================
-jQuery UI provides interactions like Drag and Drop and widgets like Autocomplete, Tabs and Slider and makes these as easy to use as jQuery itself.
+This fork of jQuery UI includes a Twitter like ticker in the ticker branch. A [live demo](http://medihack.github.com/tickerdemo/) with some customized style sheets can be found [here](http://medihack.github.com/tickerdemo/).
-If you want to use jQuery UI, go to [jqueryui.com](http://jqueryui.com) to get started. Or visit the [Using jQuery UI Forum](http://forum.jquery.com/using-jquery-ui) for discussions and questions.
+The Ticker in its raw form is fully compatible with the jQuery UI Theming framework. It is also quite flexible and fully Unit tested (qunit).
-If you are interested in helping developing jQuery UI, you are in the right place.
-To discuss development with team members and the community, visit the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui).
+There are several options to easily customize the visualization:
+
+ $("#ticker").ticker({ // #ticker is the id of an
element that contains the
ticker elements
+ initialTimeout: 2000, // the initial timeout to start the ticker after the site was loaded (in ms)
+ mouseOnTimeout: 6000, // the timeout before the next item shows up when the mouse pointer is over the ticker
+ mouseOffTimeout: 4000, // the timeout before the next item shows up when the mouse pointer is somewhere else
+ scrollTime: 1200, // the times it takes to scroll down the item list
+ fadeTime: 1000, // the time it takes to fade in the next item at the top of the item list
+ next: function(lastItem, nextItem) { // this function provides a clone of the last item on the list that will be removed next
+ return $("
next item
"); // the next item for the ticker can be returned
+ // or
+ nextItem($("
next item
")); // or be provided to the nextItem function (useful for asynchronous Ajax requests)
+ } // the next item must be wrapped in a
tag
+ });
+
+If the nextItem function was not called before the next scroll would take place then the next scroll is passed.
+
+There are also several events fired:
+beforeScroll // directly before the ticker scrolls
+afterScroll // directly after the ticker scrolled
+afterFade // directly after the new item was faded in
+
+To bind to an event (the common jQuery UI way):
+
+ $("#ticker").ticker({
+ nextItem: function(lastItem, nextItem) { nextItem($('
TestItem
')); },
+ beforeScroll: function(event, ui) { // just do what you like to do }
+ });
+
+We also provide some methods:
+stop // stop the ticker immediately (respectively after the scrolling/fading is finished)
+start // start the ticker again
+
+To call those methods (the common jQuery UI way):
+
+ $("#ticker").ticker("stop");
\ No newline at end of file
diff --git a/tests/static/ticker/default.html b/tests/static/ticker/default.html
new file mode 100644
index 00000000000..bf8625a7c73
--- /dev/null
+++ b/tests/static/ticker/default.html
@@ -0,0 +1,36 @@
+
+
+
+
+ Ticker Static Test : Default
+
+
+
+
+
+
+
+
+
").appendTo('body').ticker().remove();
+ ok(true, '.ticker() called on element');
+
+ $([]).ticker().remove();
+ ok(true, '.ticker() called on empty collection');
+
+ $('
').ticker().remove();
+ ok(true, '.ticker() called on disconnected DOMElement - never connected');
+
+ $('
').appendTo('body').remove().ticker().remove();
+ ok(true, '.ticker() called on disconnected DOMElement - removed');
+
+ var el = $('
').ticker();
+ var foo = el.ticker("option", "foo");
+ el.remove();
+ ok(true, 'arbitrary option getter after init');
+
+ $('
Nam dui erat, auctor a, dignissim quis, sollicitudin eu, felis. Pellentesque nisi urna, interdum eget, sagittis et, consequat vestibulum, lacus. Mauris porttitor ullamcorper augue.