Customization Options
You can pass a few different custom parameters to change the way that SlideDeck is presented and interacted with. Just pass a single object to the .slidedeck(); action.
| speed | Integer – The speed in milliseconds at which the movement of each slide happens (default: |
|---|---|
| transition | String – The easing method to transition between each slide. jQuery by default only has |
| start | Integer – The slide to start on (default: |
| index | This option can be passed a boolean value to turn on/off the slide indexes. You can also optionally pass an array for the index labels. (default: |
| scroll | Boolean – This option can be passed a boolean value to turn on/off the mouse wheel scrolling ability (which requires a mouse wheel extension to operate). You can also set this to the string value |
| keys | Boolean – This option can be passed a boolean value to turn on/off the ability to navigate the SlideDeck with the left and right arrow keys (default: |
| activeCorner | Boolean – Add a tag to each slide that will act as a small indicator overlapping the content (default: |
| hideSpines | Boolean – Hide the spines (slide titles) for each slide to get more space for your slides (default: |
| autoPlay | Boolean – Automatically progress through slides. AutoPlay will stop autoplaying if a user interacts with the SlideDeck navigation (default: |
| autoPlayInterval | Integer – The interval at which the slides should progress at in milliseconds. This option is only used if |
| cycle | Boolean – Automatically cycle the SlideDeck back to the first slide when using the keyboard or mouse to navigate. This feature is also useful when used in conjunction with the |
| controlProgress | Pro Version Feature: Boolean – Lock down slides to prevent the user from interacting with the SlideDeck. Use the |
| cufonRefresh | Pro Version Feature: String – Specify the slide titles to be refreshed upon slide animation when using cufon font treatment on slide titles. NOTE: When you define // Have a Cufon.replace() action specifying the slide titles
Cufon.replace('dl.slidedeck dt');
// Pass the CSS path to the cufonRefresh option
$('dl.slidedeck').slidedeck({
cufonRefresh: 'dl.slidedeck dt'
});
|
| complete | Pro Version Feature: Function – Pass a function to run after the user has moved to a slide. This function will be run on each slide and receives the SlideDeck object as a parameter so it can be interacted with in the function. $('#deck_1').slidedeck({
complete: function(deck){
// Alert the current slide number after animating
alert(deck.current);
}
});
|
| before | Pro Version Feature: Function – Pass a function to run before the user has moved to a slide. This function will be run on each slide and receives the SlideDeck object as a parameter so it can be interacted with in the function. $('#deck_1').slidedeck({
before: function(deck){
// Alert the current slide number before animating
alert(deck.current);
}
});
|

