Skip to content
This repository has been archived by the owner on Jan 3, 2019. It is now read-only.

jrrucker/player

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#jQuery Player

This jQuery Player (what others commonly refer to as a slider) is style agnostic. It assumes that you will provide a resonable amount of style to integrate it with your project. This is done intentionally to allow us to easily translate it from design to design. If you're looking for something you won't need to customize, this isn't the player for you.

This plugin was created by created by Josh Rucker, NC State Unversity Communications and is distributed under the MIT license.

The last release of this plugin was v1.1.2 on 2014-02-10.

##Usage Guide

###Basic Usage

The most basic usage case of the player:

$(elem).player();

###Advanced Usage

Initilizing the player with options:

$(elem).player({
	animationDuration: 500,
	rotates: true,
	interval: 8000,
	itemClass: 'player-item',
	hasPagers: true
});

###Configuratble Options

The following options can be set via

####Animation Duration

animationDuration: sets the animation(transition) speed in milliseconds between slides.

Default: 500

####Rotation

rotates: enables/disables auto rotation when true.

Default: true

####Transition Interval

interval: sets the length of time between transitions in milliseconds.

Default: 8000

####Item Class

itemClass: the CSS class that denotes a slide item. Only ttems tagged with the specified class will be presumed to be a "slide."

Default: 'player-item'

####Pagers

hasPagers: enables/disables control elements in the form of buttons that align to each slide.

Default: true

Change Log

  • 2014-02-10: (v1.1.2) Cleaned up source, added basic comments, made minor udpates to plugin organization.

About

A style agnostic jQuery "feature" player built for www.ncsu.edu.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published