• Download

Class

Element

Fx

User Interface

Utilities

Widgets

 

Class: SimpleSlides {#SimpleSlides}

Simple slide show that pulls creates labels for each slide dynamically and injecting them into a navigation element. It can loop through each slide, or go directly to one from any other.

Implements:

Options, Events, Loop

SimpleSlides Method: constructor {#SimpleSlides:constructor}

Syntax:

var mySimpleSlides = new SimpleSlides(container, navigation, options);

Arguments:

1. container - (mixed) A string of the id for an Element or an Element reference that contains the slides.
2. navigation - (mixed) A string of the id for an Element or an Element reference in which to inject the slide labels.
3. options - (object) See below:

Options:

• labelStorageAttribute - (string: defaults to alt) The attribute from which to pull to generate the label text. Accepts html characters.
• slideSelector - (string: defaults to img) A css selector referencing the slides from within the container
• attributePrefix - (string: defaults to simple_slides_) Appended to the id's and class names of elements (the labels, the current slide's label, etc.)
• labelEvent - (string: defaults to click) The event added to a label to show it's corresponding slide.
• delay - (number: defaults to 4000) The delay between slide transitions

Events:

showStart

• (function) The function to execute when the transition from one slide to the next begins.

Signature

onShowStart(lastIndex, nextIndex)

Arguments:

1. lastIndex - (number) The index of the slide that is transitioning out.
2. nextIndex - (number) The index of the slide that is transition in.

showComplete

• (function) The function to execute when the transition from one slide to the next finishes.

Signature

onShowComplete(index)

Arguments:

1. index - (number) The index of the slide that is now visible.

labelEvent

• (function) The function to execute when the event attached to a label is fired (usually click, unless otherwise defined in your options.)

Signature

onLabelEvent(index)

Arguments:

1. index - (number) The index of the label.