Skip to content

TrySound/skrollr-decks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#skrollr-decks

skrollr plugin for fullpage presentation decks

##Installation

bower i skrollr-decks

Add 'skrollr-decks-init' class to <body> and 'skrollr-deck' class to every section.

##API

###skrollr.decks.init(options)

  • options.decks (.skrollr-deck) - decks classname
  • offset (15) - offset in percents to deck since which will autoscroll
  • duration(600) - scrolling duration
  • easing(quaratic) - scrolling easing, more
  • delay(500) - delay before scroll
  • autoscroll(true)

###skrollr.decks.refresh()

Recalc height of all decks. Need to update when content added

###skrollr.decks.animateTo(anchor, noAnimation)

  • anchor - #id of deck, up or down
  • noAnimation - prevents animation

###skrollr.decks.on(event, callback)

  • change(activeElement) - calls when active deck is changed
  • render(e) - skrollr render event

##License

The MIT License (MIT)

Copyright © 2014 Bogdan Chadkin