skrollr plugin for fullpage presentation decks
Clone or download
TrySound Merge pull request #26 from samuweiss/master
Bugfix local.history width Basurl-Tag
Latest commit 6eaf889 Jul 20, 2015

README.md

#skrollr-decks

skrollr plugin for fullpage presentation decks

##Installation

bower i skrollr-decks
<body class="skrollr-decks-init" data-skrollr-decks-history="true">
	<main id="skrollr-body">
		<section class="skrollr-deck"></section>
		<section class="skrollr-deck"></section>
		<section class="skrollr-deck"></section>
	</main>
</body>

##API

###skrollr.decks.init(options)

  • options.decks (.skrollr-deck) - decks classname
  • offset (10) - 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)
  • history (false) - hash navigation

###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(activeDeck) - calls when active deck is changed
  • render(e) - skrollr render event

##License

The MIT License (MIT)

Copyright © 2014 Bogdan Chadkin