Skip to content

Commit

Permalink
Merge branch 'develop' of https://github.com/adamnbowen/SlideShow int…
Browse files Browse the repository at this point in the history
…o adamnbowen-develop
  • Loading branch information
ryanflorence committed Mar 20, 2011
2 parents e0c6745 + a8d78f6 commit 92a1dd8
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
3 changes: 2 additions & 1 deletion .gitignore
@@ -1 +1,2 @@
drafts
drafts
*.swp
28 changes: 14 additions & 14 deletions Docs/SlideShow/SlideShow.md
Expand Up @@ -11,7 +11,7 @@ Options, Events, [Loop](https://github.com/rpflorence/Loop)


SlideShow Method: constructor {#SlideShow:constructor}
-------------------------------------------------------
------------------------------------------------------

### Syntax:

Expand Down Expand Up @@ -60,11 +60,11 @@ SlideShow Event: onShow {#SlideShow:onShow}
slideData.next.element; // the actual DOM element
slideData.next.index; // the index of the element in the slideshow
slideData.previous.element;
slideData.prevoius.index;
slideData.previous.index;
});

SlideShow Event: onShowComplete {#SlideShow:onShowComplete}
-------------------------------------------
-----------------------------------------------------------

* (*function*) Executes when a slide transition ends.

Expand All @@ -77,7 +77,7 @@ SlideShow Event: onShowComplete {#SlideShow:onShowComplete}
* slideData - (*object*) An object containing slide data the same as `onShow`.

SlideShow Method: show {#SlideShow:show}
-----------------------------------------
----------------------------------------

Transitions from one slide to another.

Expand Down Expand Up @@ -112,7 +112,7 @@ This SlideShow instance.
});

SlideShow Method: setup {#SlideShow:setup}
-----------------------------------------
------------------------------------------

Called automatically in the constructor, unless the `noSetup` argument is provided. Initializes the slideshow, you can reinitialize on demand. Mostly useful when slides are dynamically added.

Expand All @@ -137,7 +137,7 @@ This SlideShow instance.


SlideShow Method: play {#SlideShow:play}
-----------------------------------------
----------------------------------------

Auto-plays the slideshow on the `options.delay`.

Expand All @@ -152,7 +152,7 @@ This SlideShow instance.


SlideShow Method: pause {#SlideShow:pause}
-----------------------------------------
------------------------------------------

Pauses the auto-play.

Expand All @@ -167,7 +167,7 @@ This SlideShow instance.


SlideShow Method: reverse {#SlideShow:reverse}
-----------------------------------------
----------------------------------------------

Reverses the slideshow auto-play direction.

Expand All @@ -185,7 +185,7 @@ This SlideShow instance.


SlideShow function: defineTransition {#SlideShow:defineTransition}
------------------------------------------------------------
------------------------------------------------------------------

Adds a custom transition to the SlideShow class to be used in any instances.

Expand Down Expand Up @@ -231,7 +231,7 @@ When a transition starts:


SlideShow function: defineTransition {#SlideShow:defineTransition}
------------------------------------------------------------
------------------------------------------------------------------

Same as `defineTransition` except that it takes an object map of transition names and functions.

Expand Down Expand Up @@ -294,7 +294,7 @@ Element shortcut method to create a slideshow instance with this element.
1. options (*object*) - Same options as the constructor except `autoplay` will be ignored.

Element method: pauseSlideShow {#Element:pauseSlideShow}
------------------------------------------------------
--------------------------------------------------------

Element shortcut method to pause a slideshow instance created with the `playSlideShow` method.

Expand All @@ -320,17 +320,17 @@ SlideShow Method: showNext {#Deprecated:showNext}
Deprecated, use `show('next')`.

SlideShow Method: showPrevious {#Deprecated:showPrevious}
-------------------------------------------------
---------------------------------------------------------

Deprecated, use `show('previous')`.

SlideShow Method: resetOptions {#Deprecated:resetOptions}
--------------------------------------------------------
---------------------------------------------------------

Deprecated, use `setup(options)`.

SlideShow function: add {#Deprecated:add}
----------------------------------------
-----------------------------------------

Deprecated, use `addTransition`

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -39,7 +39,7 @@ Events
------

- `onShow`
- `onShowComplte`
- `onShowComplete`
- `onPlay`
- `onPause`
- `onReverse`
Expand Down

0 comments on commit 92a1dd8

Please sign in to comment.