Skip to content
This repository has been archived by the owner on Jun 7, 2020. It is now read-only.

Commit

Permalink
fixed all documentation using old style instantiation
Browse files Browse the repository at this point in the history
  • Loading branch information
johnnyfreeman committed May 14, 2014
1 parent b7be724 commit 74b8b07
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 9 deletions.
3 changes: 2 additions & 1 deletion docs/options/onpause.md
Expand Up @@ -5,9 +5,10 @@
This is a callback that you can pass through the options object to the constructor. Internally, it is registered as a listener to the [pause](../events/pause.md) event using the [on](../methods/on.md) method. The `this` variable inside the callback is equal to the Revolver instance.

```javascript
var slider = new Revolver($('.slides'), {
var slider = new Revolver({
onPause: function() {
// this == slider
}
// ...
});
```
3 changes: 2 additions & 1 deletion docs/options/onplay.md
Expand Up @@ -5,9 +5,10 @@
This is a callback that you can pass through the options object to the constructor. Internally, it is registered as a listener to the [play](../events/play.md) event using the [on](../methods/on.md) method. The `this` variable inside the callback is equal to the Revolver instance.

```javascript
var slider = new Revolver($('.slides'), {
var slider = new Revolver({
onPlay: function() {
// this == slider
}
// ...
});
```
3 changes: 2 additions & 1 deletion docs/options/onready.md
Expand Up @@ -5,9 +5,10 @@
This is a callback that you can pass through the options object to the constructor. Internally, it is registered as a listener to the [ready](../events/ready.md) event using the [on](../methods/on.md) method. The `this` variable inside the callback is equal to the Revolver instance.

```javascript
var slider = new Revolver($('.slides'), {
var slider = new Revolver({
onReady: function() {
// this == slider
}
// ...
});
```
3 changes: 2 additions & 1 deletion docs/options/onrestart.md
Expand Up @@ -5,9 +5,10 @@
This is a callback that you can pass through the options object to the constructor. Internally, it is registered as a listener to the [restart](../events/restart.md) event using the [on](../methods/on.md) method. The `this` variable inside the callback is equal to the Revolver instance.

```javascript
var slider = new Revolver($('.slides'), {
var slider = new Revolver({
onRestart: function() {
// this == slider
}
// ...
});
```
3 changes: 2 additions & 1 deletion docs/options/onstop.md
Expand Up @@ -5,9 +5,10 @@
This is a callback that you can pass through the options object to the constructor. Internally, it is registered as a listener to the [stop](../events/stop.md) event using the [on](../methods/on.md) method. The `this` variable inside the callback is equal to the Revolver instance.

```javascript
var slider = new Revolver($('.slides'), {
var slider = new Revolver({
onStop: function() {
// this == slider
}
// ...
});
```
5 changes: 4 additions & 1 deletion docs/options/rotationspeed.md
Expand Up @@ -5,5 +5,8 @@
This option is passed through the options object to the constructor. It is the number of milliseconds Revolver will wait before transitioning to the next slide.

```javascript
var slider = new Revolver(slides, { rotationSpeed: 2000 }); // slider will go to next slide every 2 seconds
var slider = new Revolver({
rotationSpeed: 2000
// ...
}); // slider will go to next slide every 2 seconds
```
3 changes: 2 additions & 1 deletion docs/options/transition.name.md
Expand Up @@ -7,10 +7,11 @@ This option dictates what method will handle the transition from one slide to th
It can be passed to the constructor (under the [transition](transition.md) namespace).

```javascript
var slider = new Revolver(slides, {
var slider = new Revolver({
transition: {
name: 'myCustomTransition'
}
// ...
});
```

Expand Down
3 changes: 2 additions & 1 deletion docs/options/transition.oncomplete.md
Expand Up @@ -5,7 +5,8 @@
This is a callback that you can pass through the options object to the constructor. Internally, it is registered as a listener to the [transitionComplete](../events/transitioncomplete.md) event using the [on](../methods/on.md) method. The `this` variable inside the callback is equal to the Revolver instance.

```javascript
var slider = new Revolver($('.slides'), {
var slider = new Revolver({
// ...
transition: {
onComplete: function() {
// this == slider
Expand Down
3 changes: 2 additions & 1 deletion docs/options/transition.onstart.md
Expand Up @@ -5,7 +5,8 @@
This is a callback that you can pass through the options object to the constructor. Internally, it is registered as a listener to the [transitionStart](../events/transitionstart.md) event using the [on](../methods/on.md) method. The `this` variable inside the callback is equal to the Revolver instance.

```javascript
var slider = new Revolver($('.slides'), {
var slider = new Revolver({
// ...
transition: {
onStart: function() {
// this == slider
Expand Down

0 comments on commit 74b8b07

Please sign in to comment.