[](http://travis-ci.org/markdalgleish/stellar.js) [](https://gitter.im/markdalgleish/stellar.js)
# Stellar.js
> **PLEASE NOTE:** This project is no longer maintained. If parallax scrolling is something you care about, please [apply to become a contributor to this project](https://github.com/markdalgleish/stellar.js/issues/116#issuecomment-76816489).
### Parallax scrolling made easy
Full guide and demonstrations available at the [official Stellar.js project page](http://markdalgleish.com/projects/stellar.js/).
## Download
Get the [development](https://raw.github.com/markdalgleish/stellar.js/master/jquery.stellar.js) or [production](https://raw.github.com/markdalgleish/stellar.js/master/jquery.stellar.min.js) version, or use a [package manager](https://github.com/markdalgleish/stellar.js#package-managers).
## Getting Started
Stellar.js is a jQuery plugin that provides parallax scrolling effects to any scrolling element. The first step is to run `.stellar()` against the element:
``` js
// For example:
$(window).stellar();
// or:
$('#main').stellar();
```
If you're running Stellar.js on 'window', you can use the shorthand:
``` js
$.stellar();
```
This will look for any parallax backgrounds or elements within the specified element and reposition them when the element scrolls.
## Mobile Support
Support in Mobile WebKit browsers requires a touch scrolling library, and a slightly tweaked configuration. For a full walkthrough on how to implement this correctly, read my blog post ["Mobile Parallax with Stellar.js"](http://markdalgleish.com/2012/10/mobile-parallax-with-stellar-js).
Please note that parallax backgrounds are not recommended in Mobile WebKit due to performance constraints. Instead, use parallax elements with static backgrounds.
## Parallax Elements
If you want elements to scroll at a different speed, add the following attribute to any element with a CSS position of absolute, relative or fixed:
``` html
<div data-stellar-ratio="2">
```
The ratio is relative to the natural scroll speed, so a ratio of 0.5 would cause the element to scroll at half-speed, a ratio of 1 would have no effect, and a ratio of 2 would cause the element to scroll at twice the speed. If a ratio lower than 1 is causing the element to appear jittery, try setting its CSS position to fixed.
In order for Stellar.js to perform its calculations correctly, all parallax elements must have their dimensions specified in pixels for the axis/axes being used for parallax effects. For example, all parallax elements for a vertical site must have a pixel height specified. If your design prohibits the use of pixels, try using the ['responsive' option](#configuring-everything).
## Parallax Backgrounds
If you want an element's background image to reposition on scroll, simply add the following attribute:
``` html
<div data-stellar-background-ratio="0.5">
```
As with parallax elements, the ratio is relative to the natural scroll speed. For ratios lower than 1, to avoid jittery scroll performance, set the element's CSS 'background-attachment' to fixed.
## Configuring Offsets
Stellar.js' most powerful feature is the way it aligns elements.
All elements will return to their original positioning when their offset parent meets the edge of the screen—plus or minus your own optional offset. This allows you to create intricate parallax patterns very easily.
Confused? [See how offsets are used on the Stellar.js home page.](http://markdalgleish.com/projects/stellar.js/#show-offsets)
To modify the offsets for all elements at once, pass in the options:
``` js
$.stellar({
horizontalOffset: 40,
verticalOffset: 150
});
```
You can also modify the offsets on a per-element basis using the following data attributes:
``` html
<div data-stellar-ratio="2"
data-stellar-horizontal-offset="40"
data-stellar-vertical-offset="150">
```
## Configuring Offset Parents
By default, offsets are relative to the element's offset parent. This mirrors the way an absolutely positioned element behaves when nested inside an element with a relative position.
As with regular CSS, the closest parent element with a position of relative or absolute is the offset parent.
To override this and force the offset parent to be another element higher up the DOM, use the following data attribute:
``` html
<div data-stellar-offset-parent="true">
```
The offset parent can also have its own offsets:
``` html
<div data-stellar-offset-parent="true"
data-stellar-horizontal-offset="40"
data-stellar-vertical-offset="150">
```
Similar to CSS, the rules take precedence from element, to offset parent, to JavaScript options.
Confused? [See how offset parents are used on the Stellar.js home page.](http://markdalgleish.com/projects/stellar.js/#show-offset-parents)
Still confused? [See what it looks like with its default offset parents.](http://markdalgleish.com/projects/stellar.js/#show-offset-parents-default) Notice how the alignment happens on a per-letter basis? That's because each letter's containing div is its default offset parent.
By specifying the h2 element as the offset parent, we can ensure that the alignment of all the stars in a heading is based on the h2 and not the div further down the DOM tree.
## Configuring Scroll Positioning
You can define what it means for an element to 'scroll'. Whether it's the element's scroll position that's changing, its margins or its CSS3 'transform' position, you can define it using the 'scrollProperty' option:
``` js
$('#gallery').stellar({
scrollProperty: 'transform'
});
```
This option is what allows you to run [Stellar.js on iOS](http://markdalgleish.com/projects/stellar.js/demos/ios.html).
You can even define how the elements are repositioned, whether it's through standard top and left properties or using CSS3 transforms:
``` js
$('#gallery').stellar({
positionProperty: 'transform'
});
```
Don't have the level of control you need? Write a plugin!
Otherwise, you're ready to get started!
## Configuring Everything
Below you will find a complete list of options and matching default values:
``` js
$.stellar({
// Set scrolling to be in either one or both directions
horizontalScrolling: true,
verticalScrolling: true,
// Set the global alignment offsets
horizontalOffset: 0,
verticalOffset: 0,
// Refreshes parallax content on window load and resize
responsive: false,
// Select which property is used to calculate scroll.
// Choose 'scroll', 'position', 'margin' or 'transform',
// or write your own 'scrollProperty' plugin.
scrollProperty: 'scroll',
// Select which property is used to position elements.
// Choose between 'position' or 'transform',
// or write your own 'positionProperty' plugin.
positionProperty: 'position',
// Enable or disable the two types of parallax
parallaxBackgrounds: true,
parallaxElements: true,
// Hide parallax elements that move outside the viewport
hideDistantElements: true,
// Customise how elements are shown and hidden
hideElement: function($elem) { $elem.hide(); },
showElement: function($elem) { $elem.show(); }
});
```
## Writing a Scroll Property Plugin
Out of the box, Stellar.js supports the following scroll properties:
'scroll', 'position', 'margin' and 'transform'.
If your method for creating a scrolling interface isn't covered by one of these, you can write your own. For example, if 'margin' didn't exist yet you could write it like so:
``` js
$.stellar.scrollProperty.margin = {
getLeft: function($element) {
return parseInt($element.css('margin-left'), 10) * -1;
},
getTop: function($element) {
return parseInt($element.css('margin-top'), 10) * -1;
}
}
```
Now, you can specify this scroll property in Stellar.js' configuration.
``` js
$.stellar({
scrollProperty: 'm

小徐博客
- 粉丝: 2040
- 资源: 5906
最新资源
- 基于Lua语言的U3D宫格与面板设计源码学习案例
- KEY_S0015 51单片机信号发生器.zip666
- 基于Vue的勤工俭学后端项目设计源码
- 基于腾讯云TRTC平台的实时音视频终端组件设计源码
- 基于Netty的MobileIMSDK移动端IM通信层框架设计源码
- 基于Python的案例库管理系统设计与实现源码
- 基于C语言的电子墨水屏代码设计源码
- 基于Vue框架的综合性法律项目设计源码
- 基于Java和Lua语言的O2O****项目设计源码
- 基于Python的ChineseNMT机器翻译设计源码
- 基于Jupyter Notebook的Python编程技巧分享设计源码
- 基于Jupyter Notebook的互联网三班测试设计源码
- Golang入门到实践:构建你的第一个项目基础教程
- 春节主题Python编程基础教程
- JavaEE框架项目实战:搭建企业级电商系统基础教程
- CC++源码解析与实战应用基础教程
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈


