Stand-alone parallax scrolling JavaScript library for mobile (Android, iOS, etc.) and desktop in just over 9.6k (minified) or 4.5k (minified + gzipped).
Designer friendly. No JavaScript skills needed. Just plain CSS and HTML.
Actually, skrollr is much more than "just" parallax scrolling. It's a full-fledged scrolling animation library. In fact, you can use it and still have no parallax scrolling at all. But I wanted to sound hip and use some buzz-words. By the way, skrollr leverages HTML5 and CSS3 ;-)
- skrollr-menu - Hash navigation
- skrollr-ie - IE < 9 CSS fixes
- skrollr-stylesheets - Keyframes inside CSS files
- http://www.cabletv.com/the-walking-dead
- http://hypervenom.nike.com/
- http://www.photo-mark.com/funhouse/chess/
- http://www.entropy-thegame.com/
- http://nclud.com/welcome/
- http://moto.oakley.com/
- http://pixeljuice.ru/en
- http://everylastdrop.co.uk/
- http://erfgenaam.submarinechannel.com/en/
- http://www.guardian.co.uk/world/interactive/2012/dec/21/2012-america-year-review
- http://www.guardian.co.uk/world/interactive/2012/nov/06/america-elect-graphic-novel
- http://www.officeline.se/kampanj/
- http://www.direct.tv/thekingsroadmap/
- http://www.evanshalshaw.com/bondcars/
- http://www.edel-und-stein.com/
- http://erikreyna.com/ofthestreet/index.html
- https://squareup.com/careers/creative
- http://happy.is
- http://www.futuremylove.com/
- http://jonnyacevedo.com/
- http://www.guardian.co.uk/info/developer-blog/2012/nov/20/how-we-built-america-elect-graphic-novel-interactive
- http://webdesign.tutsplus.com/tutorials/htmlcss-tutorials/jazz-up-a-static-webpage-with-subtle-parallax/
- http://pepsized.com/merry-scrolling-with-skrollr-js/
- https://rubygems.org/gems/skrollr-rails
- https://gist.github.com/Prinzhorn/5796546
Want to get added? Just fork & pull request or tweet me @Prinzhorn
First of all: look at the examples and read the source ;-). This might give you a feeling of how stuff works and you can see how some patterns can be implemented.
skrollr allows you to animate any CSS property of any element depending on the horizontal scrollbar position. All you need to do is define key frames for each element at certain points in top scroll offset.
Other libraries require you to write JavaScript in order to define your animations. This introduces two main problems:
- Animation and element are not at one place. In order to find out if any animations are defined for a given element, you have to scroll through many (sometimes thousands) of lines of JavaScript.
- You have to learn a new syntax which is often very verbose and limited at the same time.
With skrollr, you put the definition of your key frames right where they belong (to the element) using a syntax you already know (plain CSS).
If you rather want the keyframes inside a separate file, take a look at skrollr-stylesheets.
If you're familiar with CSS, you already know the style
attribute. In order to create an animation you would need several, at least two, of them. That's what skrollr does. You use the HTML5 data-
attributes to define multiple sets of styles (we call each of them keyframe) and skrollr interpolates between them.
Let's change the background-color of a div
starting at #00f
when the scrollbar is at the top and ending with #f00
when the user scrolled 500 pixels down
<div data-0="background-color:rgb(0,0,255);" data-500="background-color:rgb(255,0,0);">WOOOT</div>
- Skrollr ensures that you can actually scroll down 500 pixels or more, even if there's not enough content. You can suppress this using the
forceHeight
option - You can't use
#00f
or#0000ff
. You need to usergb
orhsl
and explicitly decide which color space you want because they result in different animations (HSL is much cooler most of the time). Don't worry, the IE plugin teaches IE < 9 to displayrgb
andhsl
correctly.
<div data-0="background-color:rgb(0,0,255);transform:rotate(0deg);" data-500="background-color:rgb(255,0,0);transform:rotate(360deg);">WOOOT</div>
- Skrollr handles all these nasty CSS prefixes for you. Just -moz-relax and get yourself a cup of -webkit-coffee
<div data-0="background-color:rgb(0,0,255);transform[bounce]:rotate(0deg);" data-500="background-color:rgb(255,0,0);transform[bounce]:rotate(360deg);">WOOOT</div>
- Skrollr allows non-linear animations. The so called easing functions can be used per-property by putting them in square brakets behind the property. There's a built-in list of easing functions (see below in the JavaScript section) and you can use your own functions by using the
easings
options.
Now you may have noticed that using 500
as a keyframe position is kind of random and the look depends on your browser size.
Let's have the animation end when the top of the element reaches the top of the viewport (element leaves the viewport)
<div data-0="background-color:rgb(0,0,255);transform[bounce]:rotate(0deg);" data-top="background-color:rgb(255,0,0);transform[bounce]:rotate(360deg);">WOOOT</div>
That's the end of this short intro. The following sections will explain some more things in detail.
If you're not a fan of data-attributes
or if you're planning a big website where you want a better and more flexible structure, take a look at skrollr-stylesheets.
Starting with version 0.5.0 skrollr officially supports mobile browsers including Android and iOS. And mobile support has been rewritten from scratch for skrollr 0.6.0.
(If you're not interested in the details, just scroll down a bit to see what you need to do for mobile support)
Some words on why this is an important milestone and why others failed: Mobile browsers try to save battery wherever they can. That's why mobile browsers delay the execution of JavaScript while you are scrolling. iOS in particular does this very aggressively and completely stops JavaScript. And in short that's the reason why many scrolling libraries either don't work on mobile devices or they come with their own scrollbar which is a usability nightmare on desktop. It was an important requirement while I developed skrollr that I don't force you to scroll the way I want it. skrollr on desktop uses a native scrollbar and you can scroll the way you want to (keyboard, mouse, etc.).
You just told me it doesn't work on mobile, but why does it? The answer is simple. When using skrollr on mobile you don't actually scroll. When detecting a mobile browser skrollr disables native scrolling and instead listens for touch events and moves the content (more specific the #skrollr-body
element) using CSS transforms.
Starting with skrollr 0.6.0 there's just one thing you need to do: Include an element on your page with the id skrollr-body
. That's the element we move in order to fake scrolling. The only case were you don't need a #skrollr-body
is when using position:fixed
exlusively. In fact the skrollr website doesn't include a #skrollr-body
element. If you need both fixed and non-fixed (i.e. static) elements, put the static ones inside the #skrollr-body
element.
Being only able to define key frames in absolute values is simply insufficient for some cases. For example if you don't know where an element will exactly be in the document. That's why there are two modes for key frames, namely absolute
and relative
mode.
The key frames are defined as absolute values describing how much the document has been scrolled down.
The syntax is data-[offset]-[anchor]
, where offset
can be any integer (0 is default) and anchor
can be either start
(default) or end
. Either offset
or anchor
can be ommited in some situations. Here are some examples of key frames and their meaning.
data-0
=data-start
=data-0-start
: When the scroll top is 0.data-100
=data-100-start
: When the scroll top is 100.data--100
=data--100-start
: When the scroll top is -100 (sounds like nonsense, but keep in mind that interpolation will be relative to this point).data-end
=data-0-end
: When offset is 0, but counting from the bottom of the document instead of from the top. In short: when you reach the bottom of the page.data-100-end
: 100px before we reach the bottom.data--100-end
: 100px after we reach the bottom (again, it's up to you whether you need it).
Instead of defining key frames relative to the document (i.e. absolute), we are able to define them depending on the position of any element in relation to the viewport.
The syntax is data-[offset]-(viewport-anchor)-[element-anchor]
, where offset
can again be any integer and defaults to 0. Both viewport-anchor
(mandatory) and element-anchor
(optional) can be one of top
, center
or bottom
. If element-anchor
is ommitted, the value of viewport-anchor
will be taken (just like with background-position). Here are some examples of key frames and their meaning.
data-top
=data-0-top
=data-top-top
=data-0-top-top
: When the element's top is aligned with the top of the viewport.data-100-top
=data-100-top-top
: When the element's top is 100px above the top of the viewport.data--100-top
=data--100-top-top
: When the element's top is 100px below the top of the viewport.data-top-bottom
=data-0-top-bottom
: When the bottom of the element is at the top of the viewport (it's just not visible).data-center-center
=data-0-center-center
: When the element is at the center of the viewport.data-bottom-center
=data-0-bottom-center
: When the element's center is at the bottom of the viewport, thuss the upper half of the element is visible.
By default the element is the element where the key frames are defined on (self), but can be any element on the page. You can optionally specify which element you want by using the data-anchor-target
and any CSS selector. The first element on the page matching the selector will be used. data-anchor-target
requires IE 8 or greater.
Examples: data-anchor-target="#foo"
or data-anchor-target=".bar:not(.bacon) ~ span > a[href]"
Note: If you need to support IE 7, then you may only use IDs as anchor-target
s, i.e. #foo
. The IE plugin maps querySelector
to getElementById
.
Here's an infographic for better understanding of anchors (click to open PDF):
Important: All those values will be calculated up-front and transformed to absolute
mode. So if either the element's box height changes (height, padding, border) or the elements position within the document, you probably need to call refresh()
(see documentation in JavaScript section below). Window resizing is handled by skrollr.
Check out the skrollr-menu plugin.
I was lying to you. The syntax for absolute mode is not data-[offset]-[anchor]
and for relative mode it's not data-[offset]-(viewport-anchor)-[element-anchor]
. In both cases offset
can be preceeded by a constant which can be passed to the ìnit
method. The name of the constant needs to be preceeded with an underscore.
Example:
skrollr.init({
constants: {
foobar: 1337
}
});
<div data-_foobar="left:0%;" data-_foobar--100="left:50%;" data-_foobar-100="left:100%;"></div>
<!--Equal to-->
<div data-1337="left:0%;" data-1237="left:50%;" data-1437="left:100%;"></div>
Valid characters for a constant are [a-z0-9_]
.
skrollr will add a skrollr
class to the HTML
element when calling init
and will remove a no-skrollr
class if present. Additionally it will add a skrollr-desktop
or skrollr-mobile
class depending on which it detects. This allows fallback CSS rules to create a good user experience on unsupported devices or when JavaScript or skrollr are disabled.
All elements under skrollr's control (elements with appropriate data-attributes) will get the skrollable
class. In addition we add either the skrollable-before
, skrollable-between
or skrollable-after
class, depending on whether the current scroll position is before, between or after the first/last (smallest/largest) keyframe of an element.
Imagine the following animation
<div data-100="left:0%;" data-200="top:0%;" data-300="left:50%;" data-400="top:50%;"></div>
One could expect left
to have a value of 25%
at keyframe 200
. That is not the case. By design skrollr only interpolates values between key frames which are direct neighbors. What actually happens is that skrollr internally fills out all holes once from left and then from right. So the above is equivalent to
<div data-100="left:0%;top:0%;" data-200="left:0%;top:0%;" data-300="left:50%;top:0%;" data-400="left:50%;top:50%;"></div>
The reason why skrollr is so lightweight and powerfull is because it literally interpolates every number it can find. If you want to prevent some side effect, you can suppress interpolation for a specific value by prepending an exclamation point.
Example:
<!-- This will get your image url f***** up because there's no "kitten1.4561799.jpg" and the like -->
<div data-0="background-image:url(kitten1.jpg);" data-100="background-image:url(kitten2.jpg)"></div>
<!-- Better -->
<div data-0="background-image:!url(kitten1.jpg);" data-100="background-image:!url(kitten2.jpg)"></div>
Note: The values for both keyframes (at least the if they contain a number) need to be prefixed if you want to avoid skrollr throwing an exception at you!
There are some limitations of skrollr you should be aware of.
- All numeric values have to have the same unit. It's not possible to animate from
0%
to100px
. skrollr won't complain, but results are undefined. - Animations between values which are composed of multiple numeric values like
margin:0 0 0 0;
are only possible for the same number of values.margin:0px 0px 0px 0px;
tomargin:0px 100px 50px 3px;
is fine, but notmargin:10px;
tomargin:5px 10px;
. - Animations between CSS transforms only work when they use the same functions in same order. From
rotate(0deg) scale(1)
torotate(1000deg) scale(5)
is fine. - Color animations don't support named values like "red" or hex values like "#ff0000". Instead, you have to use
rgb()
,rgba()
,hsl()
andhsla()
. Don't worry, there's a skrollr plugin for IE < 9 to supporthsl()
(without "a"!) and to fall rgba back to rgb. - Color animations only work for same color functions.
hsl()
tohsl()
orhsla()
is fine, but notrgb()
tohsl()
. Which makes sense, because animating from the same colors in rgb space and in hsl space results in different animations (hsl gives you the nice rainbow stuff).
But feel free to send in a pull request to fix any of them. Just keep in mind that keeping skrollr as lightweight as possible has high priority.
On the JavaScript part there's not much to do (you can, if you want to!). So if you only know CSS and HTML, perfect.
All there is to do is to call skrollr.init([options]);
which returns an instance of the singleton skrollr class. Subsequent calls to init()
will just return the same skrollr instance again.
Possible options for init()
are
Smooth scrolling smoothens your animations. When you scroll down 50 pixel the animations will transition instead of jumping to the new position.
The global setting can be overridden per element by setting data-smooth-scrolling
to on
or off
.
The number of milliseconds the animations run after the scroll position changed the last time.
An object containing integers as values. The keys can contain [a-z0-9_]
. They do not need a leading underscore.
Example: data-_myconst-200
and skrollr.init({constants: {myconst: 300}})
result in data-500
.
By default skrollr uses the largest key frame and makes document height + viewport height this high, thus the max possible scroll top offset. If your animation runs too fast or too slow, just adjust the scale value.
When forceHeight
is set to false, scale
is ignored.
scale
affects constants
as well.
scale
does only affect key frames in absolute mode, e.g. data-500
but not data-top
.
###forceHeight=true
true
: Make sure the document is high enough that all key frames fit inside. Example: You use data-1000
, but the content only makes the document 500px high. skrollr will ensure that you can scroll down the whole 1000px. Or if you use relative mode, e.g. data-top-bottom
, skrollr will make sure the bottom of the element can actually reach the top of the viewport.
false
: Don't manipulate the document and just keep the natural scrollbar.
###mobileCheck=function() {...}
This option allows you to pass a function to skrollr overwriting the check for mobile devices. The function should return true
when mobile scrolling should be used and false
if not.
The default looks like this
function() {
return (/Android|iPhone|iPad|iPod|BlackBerry|Windows Phone/i).test(navigator.userAgent || navigator.vendor || window.opera);
}
This option specifies how to handle animations when the scroll position is outside the range on the keyframes (i.e. before the first or after the last keyframe).
One of three options are possible
set
(default): When before/after the first/last keyframe, apply the styles of the first/last keyframe to the element.ease
: Same as set, but the values will be transformed using the given easing function.reset
: When before/after the first/last keyframe, apply the styles which the element had before skrollr did anything. This means resetting the class attribute as well as removing all styles which have been applied to thestyle
property. This means the element won't have anyskrollable-*
CSS classes.
Example:
Given the following element with two keyframes
<div data-1000="left:0%;top:0%;" data-2000="left:50%;top:100%;" style="left:-100%;" class="section"></div>
and the following easing function which always returns 0.5
(I know it's pointless, but it's just an example. A real world example would be an easing function that represents a curve and starts somewhere between 0
and 1
, but not at 1
)
function(p) {
return 0.5;
}
and imagine the scrollbar is at 237
, which is below the first keyframe which is at 1000
.
set
will result in<div style="left:0%;top:0%;" class="section skrollable skrollable-before"></div>
which is plaindata-1000
.ease
will result in<div style="left:25%;top:50%;" class="section skrollable skrollable-before"></div>
which is0.5 * data-1000
.reset
will result in<div style="left:-100%;" class="section"></div>
which is what the element originally had. Note howtop
is missing.
A listener function getting called each time right before we render everything. The function will be passed an object with the following properties:
{
curTop: 10, //the current scroll top offset
lastTop: 0, //the top value of last time
maxTop: 100, //the max value you can scroll to. curTop/maxTop will give you the current progress.
direction: 'down' //either up or down
}
Returning false
will prevent rendering.
A listener function getting called right after we finished rendering everything. The function will be passed the same parameters as beforerender
An object defining new easing functions or overwriting existing ones. Easing functions get just one argument, which is a value between 0 and 1 (the percentage of how much of the animation is done). The function should return a value between 0 and 1 as well, but for some easings a value less than 0 or greater than 1 is just fine.
An easing function basically transforms the timeline for an animation. When the animation should be 50% done, you can transform it to be 90% done or whatever your function does.
Example:
skrollr.init({
easing: {
//This easing will sure drive you crazy
wtf: Math.random,
inverted: function(p) {
return 1 - p;
}
}
});
You can now use the easing functions like any other.
skrollr ships with some built in functions:
- linear: The default. Doesn't need to be specified.
- quadratic: To the power of two. So 50% looks like 25%.
- cubic: To the power of three. So 50% looks like 12.5%
- begin/end: They always return 0 or 1 respectively. No animation.
- swing: Slow at the beginning and accelerates at the end. So 25% -> 14.6%, 50% -> 50%, 75% -> 85.3%
- sqrt: Square root. Starts fast, slows down at the end.
- easeOutCubic
- bounce: Bounces like a ball. See https://www.desmos.com/calculator/tbr20s8vd2 for a graphical representation.
Returns the skrollr instance if init()
has been called before or undefined
.
Calling init()
returns an instance of skrollr which exposes a public api.
Reparses all given elements
. You can pass a single element or an array-like element (Array, NodeList, jQuery object)
Useful when
- elements in
relative
mode change and need to be updated - data-attributes are manipulated dynamically
- new elements are added to the DOM and should be controlled by skrollr
When no elements
are given, all elements in the document will be parsed again. In fact, when calling skrollr.init()
skrollr uses refresh()
without parameters internally.
Time consuming operation, should not be called on every rendering.
returns an integer which represents the absolute scroll position which correlates to the relative anchor.
element
must be a DOM element.
viewportAnchor
and elementAnchor
must be one of top
, center
or bottom
Example:
var offset = s.relativeToAbsolute(document.getElementById('foo'), 'top', 'bottom');
//offset contains the scroll position at which #foo's bottom is at the top of the viewport.
//If you now use setScrollTop(offset) or animateTo(offset) #foo's bottom will be perfectly aligned with the top of the viewport. Yay.
Returns the current scroll offset in pixels. Normalizes different browser quirks and handles mobile scrolling.
Sets the top offset using window.scrollTo(0, top)
on dektop or updating the internal state in case of mobile scrolling.
When force
is set to true
, skrollr will jump to the new position without any kind of transition. By default the global smoothScrolling
setting applies.
Animates the scroll position from current position to top
. Possible options
are
How long the animation should run in milliseconds. The default is 1000
or one second.
The name of an easing function. The same functions can be used as for property animations. Default is linear
.
A function to be called after the animation finished. When you pass a top
value, which is the same as the current, then the function will be called immediately. The function gets a boolean argument interrupted
which indicates if the animation was iterrupted by stopAnimateTo
or finished to the end.
Stops the animation and calls the done
callback passing true
as interrupted
arguments.
Returns if an animation caused by animateTo is running.
Set a listener function for one of the events described in the options section (beforerender, render). Only one listener can be attached at a given time. This method overwrites the current listener, if any.
Removes the listener for the given event.
- Improved overall performance for mobile (#249).
- Added a new option
smoothScrollingDuration
.
- Changed the default value of
edgeStrategy
fromease
toset
. There are too many cases whereease
was not wanted and unexpected.
- Fixed IE plugin not working. This was caused by assigning
skrollr.setStyle
to a local variable inside the skrollr core. Since the IE plugin monkey-patches the skrollr.setStyle function, the core didn't notice the change (#199 comment 18986949).
- Fixed crash in IE < 9 because the detected prefix was
null
(#220).
- Fixed that some elements got the
skrollable-before
andskrollable-after
class at the same time.
- When resizing the browser, the scroll position was reset to 0 (#217)
- When resizing the browser,
forceHeight
was colliding with the already forced height (#216).
- Allow numbers inside of easing function names (#152).
Expect things to break when coming from 0.5! Read through the changelog. Migration is not hard.
- [breaking] There's no more
skrollr.mobile.js
file. You only needskrollr.js
. You no longer need to conditionally includeskrollr.mobile.js
. - You can configure how skrollr detects mobile browsers using the
mobileCheck
option (check out the documentation). - [possibly breaking] The meaning of the
#skrollr-body
element changed. Put all static elements inside of it and all absolute/fixed elements outside. It doesn't need to be the first child of the body anymore. - [breaking] The
rendered
andunrendered
classes where renamed because they were confusing and wrong. They're now calledskrollable-before
andskrollable-after
, because that's their meaning (the element with these classes is before/after the first/last keyframe).- Added a new class
skrollable-between
, because symmetry. That's why.
- Added a new class
- Easing functions are now applied when exactly at a keyframe (#132).
- [possibly breaking] The behavior changed for the case when the scroll position is before/after the first/last keyframe (I'm just gonna use "before first" from now on, because "after last" is analog). In 0.5 the behavior was not exactly specified and buggy (see item above regarding #132). Skrollr was applying the styles of the first keyframe to the element for all scroll position that were before the first keyframe. E.g. when
data-100="top:200px;"
was the first keyframe, the element hadtop:200px;
at all scroll positions before (all from0
to99
). From now on you can specify the behavior you want (seeedgeStrategy
option for details, set it toset
for old behavior). Note: 0.6.7 and up useset
as default.
- Add a
skrollr-mobile
class to the html element when the mobile script is included.
- #131: Use a cross browser approach for getting the body scroll-height.
- #133: Use the maximum of document height or the max keyframe for edge cases where absolute keyframes are used in a relative-mode-like document and
data-end
was calculated wrong.
- #121: Fixed prefix detection in Safari.
- #126: When calling refresh(), force rerendering, even if the scrollbar didn't move.
- #104: Fixed the most annoying bug on mobile. There was a large blank space at the bottom of the page.
- #118: Fixed broken prefix detection. Was broken all the time, but worked before Firefox 18.
- #116 + #117: SVG support was broken for relative mode.
- #103: skrollr no longer depends on being added to the bottom of the document.
- #105: Fixed inconsistent behaviour for adding
rendered
andunrendered
class on page load
- #100: Fixed relative-mode not working correctly in IE < 9 due to crippled getBoundingClientRect
- #80: When resizing the browser window the calculation of relative mode was wrong when the element's vertical position was changed before.
- #66: Make IE 7 support a light version of
data-anchor-target
by mappingquerySelector
togetElementById
.
- #78: Fixed that new parser didn't allowed omitting the last semicolon in a keyframe property list.
- Fixed
setScrollTop
andanimateTo
not working because iScroll uses negative offset.
- breaking the
plugin
api has been removed (the IE plugin has been updated to a new, hidden api). - Full mobile support using iscroll.
- #73: Fixed parser to not mess up colons inside URLs
- #74: Fixed parser to not treat single periods as decimal numbers
- #76: Fixed dummy element overlaping the content, even though it should be unobtrusive
- #58:
forceHeight
now handles relative mode like a boss. - #59: Make
scale
option only affect absolute mode.
- #64: Setting
float
property using JavaScript didn't work across browser. Now usingstyleFloat
andcssFloat
properties.
- The
scale
option does not affectconstants
.
- Allow smooth scrolling on element level using
data-smooth-scrolling
- Added experimental smooth scrolling (no more CSS transitions. WORKS IN IE.).
- Added
stopAnimateTo
method.
- Updated the requestAnimationFrame polyfill for smoother animations
- Updated the way requestAnimationFrame is used for even smoother animations
- New method
relativeToAbsolute
which was formerly private - New method
isAnimatingTo
to check if an animation caused byanimateTo
is running - Added
sqrt
easing function
- Experimental mobile support using https://github.com/zynga/scroller
- A
skrollr
class is added to the HTML element and ano-skrollr
class is removed wheninit
is called. Useful for fallback styling.
- Added new feature "constants".
- Added new feature "anchor-target" which allows elements to react to other elements leaving/entering the viewport.
- Fixed a bug which broke skrollr in IE caused by wrong regular expression behavior
- breaking the
data-end-[offset]
syntax changed. It's nowdata-[offset]-end
. - Fixed a bug where white spaces between style declarations were not ignored.
- Added support for anchors. Animations can now be specified relative to the elements position within the viewport.
- Added support for SVG elements.
- Added new method
refresh()
.
- Alexander Prinzhorn, repo owner, main contributor
- Ali Karbassi
- Tri Nguyen
- Charles J Hardy
- Oscar Otero
- Jim Osborn
- Dowon Kang
- rbeitra
- Everyone giving feedback on Twitter and through other channels.
Special thanks to cubiq for creating iScroll which powered mobile support prior to skrollr 0.6.