Class: Fx.Scroll

Scrolls any element with an overflow, including the window element.

Note

• Fx.Scroll requires the page to be in Standards Mode.

Extends

• Fx

Fx.Scroll Method: constructor

Syntax

var myFx = new Fx.Scroll(element[, options]);

Arguments

1. element - (mixed) A string of the id for an Element or an Element reference to scroll.
2. options - (object, optional) All Fx Options in addition to offset and wheelStops.

Options:

1. offset - (object: defaults to {'x': 0, 'y': 0}) An object with x and y properties of the distance to scroll to within the Element.
2. wheelStops - (boolean: defaults to true) If false, the mouse wheel will not stop the transition from happening.

Returns

• (object) A new Fx.Scroll instance.

Examples

var myFx = new Fx.Scroll('myElement', {
    offset: {
        x: 0,
        y: 100
    }
}).toTop();

Notes

• Fx.Scroll transition will stop on mousewheel movement if the wheelStops option is not set to false. This is to allow users to control their web experience.
• Fx.Scroll is useless for Elements without scrollbars.

Fx.Scroll Method: set

Scrolls the specified Element to the x/y coordinates immediately.

Syntax

myFx.set(x, y);

Arguments

1. x - (number) The x coordinate to scroll the Element to.
2. y - (number) The y coordinate to scroll the Element to.

Returns

• (object) This Fx.Scroll instance.

Examples

var myElement = $(document.body);
var myFx = new Fx.Scroll(myElement).set(0, 0.5 * document.body.offsetHeight);

Fx.Scroll Method: start

Scrolls the specified Element to the x/y coordinates provided.

Syntax

myFx.start(x, y);

Arguments

1. x - (number) The x coordinate to scroll the Element to.
2. y - (number) The y coordinate to scroll the Element to.

Returns

• (object) This Fx.Scroll instance.

Examples

var myElement = $(document.body);
var myFx = new Fx.Scroll(myElement).start(0, 0.5 * document.body.offsetHeight);

Notes

• Scrolling to negative coordinates is impossible.

Fx.Scroll Method: toTop

Scrolls the specified Element to its maximum top.

Syntax

myFx.toTop();

Returns

• (object) This Fx.Scroll instance.

Examples

//Scrolls "myElement" 200 pixels down from its top and, after 1.5 seconds,
//back to the top.
var myFx = new Fx.Scroll('myElement', {
    onComplete: function(){
        this.toTop.delay(1500, this);
    }
}).scrollTo(0, 200).chain(function(){
    this.scrollTo(200, 0);
});

Fx.Scroll Method: toBottom

Scrolls the specified Element to its maximum bottom.

Syntax

myFx.toBottom();

Returns

• (object) This Fx.Scroll instance.

Examples

//Scrolls the window to the bottom and, after one second, to the top.
var myFx = new Fx.Scroll(window).toBottom().chain(function(){
    this.toTop.delay(1000, this);
});

Fx.Scroll Method: toLeft

Scrolls the specified Element to its maximum left.

Syntax

myFx.toLeft();

Returns

• (object) This Fx.Scroll instance.

Examples

//Scrolls "myElement" 200 pixels to the right and then back.
var myFx = new Fx.Scroll('myElement').scrollTo(200, 0).chain(function(){
    this.toLeft();
});

Fx.Scroll Method: toRight

Scrolls the specified Element to its maximum right.

Syntax

myFx.toRight();

Returns

• (object) This Fx.Scroll instance.

Examples

//Scrolls "myElement" to the right edge and then to the bottom.
var myFx = new Fx.Scroll('myElement', {
    duration: 5000,
    wait: false
}).toRight();
 
myFx.toBottom.delay(2000, myFx);

Fx.Scroll Method: toElement

Scrolls the element until the element specified is at the top/left. If an axis is specified, only scrolls along that axis.

Syntax

myFx.toElement(el[, axes]);

Arguments

1. el - (mixed) A string of the Element's id or an Element reference to scroll to.
2. axes - (array or string, optional) An array or string specifying which axes to scroll on, can be 'x', 'y', or ['x', 'y']. It defaults to both axes.

Returns

• (object) This Fx.Scroll instance.

Examples

//Scrolls the "myElement" to the top left corner of the window.
var myFx = new Fx.Scroll(window).toElement('myElement');
 
//Scrolls the "myElement" to the top corner of the window.
//Does not scroll horizontally.
var myFx = new Fx.Scroll(window).toElement('myElement', 'y');

Notes

• See Element:getPosition for position difficulties.

Fx.Scroll Method: toElementEdge

Scrolls the element until the specified element is visible along the specified axes.

Syntax

myFx.toElementEdge(el[, axes]);

Arguments

1. el - (mixed) A string of the Element's id or an Element reference to scroll to.
2. axes - (array or string, optional) An array or string specifying which axes to scroll on, can be 'x', 'y', or ['x', 'y']. It defaults to both axes.

Returns

• (object) This Fx.Scroll instance.

Examples

//Scrolls the window until "myElement" is visible, scrolling in whatever direction
//is required.
var myFx = new Fx.Scroll(window).toElementEdge('myElement');
 
//Same as above but only scrolls the window up or down.
var myFx = new Fx.Scroll(window).toElementEdge('myElement', 'y');

Fx.Scroll Method: toElementCenter

Scrolls the element until the specified element is centered along the specified axes.

Syntax

myFx.toElementCenter(el[, axes]);

Arguments

1. el - (mixed) A string of the Element's id or an Element reference to scroll to.
2. axes - (array or string, optional) An array or string specifying which axes to scroll on, can be 'x', 'y', or ['x', 'y']. It defaults to both axes.

Returns

• (object) This Fx.Scroll instance.

Examples

//Scrolls the window until "myElement" is centered in the window,
//scrolling in whatever direction is required.
var myFx = new Fx.Scroll(window).toElementCenter('myElement');
 
//Same as above but only scrolls the window up or down.
var myFx = new Fx.Scroll(window).toElementCenter('myElement', 'y');