Skip to content

Commit

Permalink
added README to slidebox
Browse files Browse the repository at this point in the history
  • Loading branch information
pennyfx committed Nov 15, 2012
1 parent 97f6927 commit 15d48ed
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions slidebox/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

## Syntax

Slidebox allows you to create slides of any content and then transition between them. It supports x and y axis transitions.

```
<x-slidebox>
<x-slides>
<x-slide><img src="demo/birnimal-calendar.png" /></x-slide>
<x-slide><img src="demo/birnimal-graph.png" /></x-slide>
<x-slide><img src="demo/birnimal-detail.png" /></x-slide>
<x-slide><img src="demo/birnimal-settings.png" /></x-slide>
</x-slides>
</x-slidebox>
```


## Events
```slideend``` is fired at the end of each transition.

```
document.getElementsByNames('x-slidebox')[0].addEventListener('slideend', function(e){
});
```

## Usage

```
var slidebox = document.getElementsByNames('x-slidebox')[0];
slidebox.slideNext();
slidebox.slidePrevious();
slidebox.slideTo(1); // index of desired x-slide
slidebox.orientation = 'y'; // slide veritically
```


0 comments on commit 15d48ed

Please sign in to comment.