Giter Club home page Giter Club logo

skrollr-decks's Introduction

#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

skrollr-decks's People

Contributors

trysound avatar qjake avatar crispen-smith avatar

Watchers

James Cloos avatar Erick Leopoldo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.