Skip to content

Nice handling of stickies bigger than the current window #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Nice handling of stickies bigger than the current window #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c09448c
Nice handling of stickies bigger than the current window
panrafal Feb 19, 2013
828e24f
fix overflow on resize
panrafal Feb 19, 2013
a609e34
allow invalidation though scroll event
panrafal Feb 19, 2013
636db6d
overflowStickClass
panrafal Feb 20, 2013
a1e4a22
some cleanup
panrafal Feb 20, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ Container that you want the sticky item to be contained in.
**stickClass: 'stickit'**<br>
Class added to the sticky item once it should start being sticky.

**activeStickClass: 'stickit-active'**<br>
Class added to the sticky item handled by the plugin (ie. not bigger than container)

**endStickClass: 'stickit-end'**<br>
Class added to the sticky item once it has reached the end of the container

Expand All @@ -52,6 +55,14 @@ Do you already have a fixed horizontal header on the page? Offset stick 'em by t
**start: 0**<br>
If your sticky item isn't at the top of the container, tell it where it should start being sticky.

**overflow: true**<br>
If a sticky is bigger than window, you'll be able to scroll it by scrolling the window. You can
disable this for backwards compatibility.

**topProperty: 'top'**<br>
CSS property to use for positioning the item. You can use 'top', 'margin-top' or false to control it
by css classes yourself. This is *required* for overflowing items.

**onStick: null**<br>
You can create a callback function that fires when an item gets "stuck". The item gets passed back.

Expand Down
6 changes: 6 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,17 @@
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
</div>

<div class="aside stickem">
<h2>Heading</h2>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>
</div>
</div>

Expand Down
67 changes: 54 additions & 13 deletions jquery.stickem.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
this.options = options;
this.metadata = this.$elem.data("stickem-options");
this.$win = $(window);
this.lastPos = 0;
};

Stickem.prototype = {
Expand All @@ -30,10 +31,14 @@
container: '.stickem-container',
stickClass: 'stickit',
endStickClass: 'stickit-end',
overflowStickClass: 'stickit-overflow',
activeStickClass: 'stickit-active',
offset: 0,
start: 0,
onStick: null,
onUnstick: null
onUnstick: null,
overflow: true,
topProperty: 'top',
},

init: function() {
Expand Down Expand Up @@ -70,11 +75,13 @@
$elem: $this,
elemHeight: $this.height(),
$container: $this.parents(_self.config.container),
isStuck: false
isStuck: $this.hasClass(_self.config.stickClass)
};

//If the element is smaller than the window
if(_self.windowHeight > item.elemHeight) {
if(_self.config.overflow || _self.windowHeight > item.elemHeight) {
item.overflowAmount = Math.max(0, item.elemHeight - _self.windowHeight);
if (item.overflowAmount && item.isStuck) item.isOverflowing = 1;
item.containerHeight = item.$container.outerHeight();
item.containerInner = {
border: {
Expand All @@ -94,10 +101,12 @@
//If the element is smaller than the container
if(item.containerInnerHeight > item.elemHeight) {
_self.items.push(item);
item.$elem.addClass(_self.config.activeStickClass);
return;
}
} else {
item.$elem.removeClass(_self.config.stickClass + ' ' + _self.config.endStickClass);
}
item.$elem.removeClass(_self.config.stickClass + ' ' + _self.config.endStickClass
+ ' ' + _self.config.activeStickClass + ' ' + _self.config.overflowStickClass);
},

getItems: function() {
Expand Down Expand Up @@ -125,12 +134,24 @@
var item = _self.items[i];

//If it's stuck, and we need to unstick it
if(item.isStuck && (pos < item.containerStart || pos > item.scrollFinish)) {
if(item.isStuck && (pos < item.containerStart || pos > item.scrollFinish + item.overflowAmount
|| (item.isOverflowing > 0 && pos >= _self.lastPos)
|| (item.isOverflowing < 0 && pos <= _self.lastPos)
)) {
item.isOverflowing = 0;
item.$elem.removeClass(_self.config.stickClass);

// set current position as absolute
if (_self.config.topProperty) {
item.$elem.css(_self.config.topProperty,
Math.max(item.containerStart, Math.min(pos + parseInt(item.$elem.css('top'),10), item.scrollFinish))
- item.$elem.offsetParent().offset().top + 'px'
);
}
//only at the bottom
if(pos > item.scrollFinish) {
item.$elem.addClass(_self.config.endStickClass);
} else if (pos > item.containerStart) {
item.$elem.addClass(_self.config.overflowStickClass);
}

item.isStuck = false;
Expand All @@ -142,15 +163,35 @@

//If we need to stick it
} else if(item.isStuck === false && pos > item.containerStart && pos < item.scrollFinish) {
item.$elem.removeClass(_self.config.endStickClass).addClass(_self.config.stickClass);
item.isStuck = true;

//if supplied fire the onStick callback
if(_self.config.onStick) {
_self.config.onStick(item);
if (_self.config.topProperty) {
if (item.overflowAmount) {
var itemOffsetTop = item.$elem.offset().top;
if (_self.lastPos < pos && itemOffsetTop + item.elemHeight < pos + _self.windowHeight) {
item.$elem.css(_self.config.topProperty, (-item.overflowAmount) + 'px');
item.isOverflowing = -1;
} else if (_self.lastPos > pos && itemOffsetTop > pos) {
item.$elem.css(_self.config.topProperty, '');
item.isOverflowing = 1;
} else if (itemOffsetTop > pos + _self.windowHeight || itemOffsetTop + item.elemHeight < pos) {
item.$elem.css(_self.config.topProperty, '');
} else {
return;
}
} else {
item.$elem.css(_self.config.topProperty, '');
}
}
item.$elem.removeClass(_self.config.endStickClass + ' ' + _self.config.overflowStickClass)
.addClass(_self.config.stickClass);
item.isStuck = true;

//if supplied fire the onStick callback
if(_self.config.onStick) {
_self.config.onStick(item);
}
}
}
_self.lastPos = pos;
}
},

Expand Down
7 changes: 6 additions & 1 deletion screen.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,19 @@ p {
margin-bottom: 1.5em;
}

.stickit-active {
position: absolute;
right: 0px;
}

.stickit {
margin-left: 660px;
position: fixed;
top: 0;
right: auto;
}

.stickit-end {
bottom: 40px;
position: absolute;
right: 0;
}