Skip to content

Commit

Permalink
Make comment scrolling much more robust.
Browse files Browse the repository at this point in the history
- Add scrollTo jquery plugin
- Add :after content using CSS so the JS can know what kind of layout is being used
  • Loading branch information
atogle committed Jul 17, 2014
1 parent 780e162 commit 8f3764c
Show file tree
Hide file tree
Showing 6 changed files with 236 additions and 9 deletions.
11 changes: 11 additions & 0 deletions src/sa_web/static/css/default.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ body {
text-align: left;
}

/* A helper to let the JS know what kind of layout we're using */
body:after {
content: "mobile";
display: none;
}

/* Links */
a, a:active, a:visited {
color: #007fbf;
Expand Down Expand Up @@ -1273,6 +1279,11 @@ a.close-unsupported-overlay {
position: relative;
}

/* A helper to let the JS know what kind of layout we're using */
body:after {
content: "desktop";
}

/* Header */
#site-header {
padding-left: 1em;
Expand Down
28 changes: 21 additions & 7 deletions src/sa_web/static/js/views/app-view.js
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,8 @@ var Shareabouts = Shareabouts || {};
viewPlace: function(model, responseId, zoom) {
var self = this,
includeSubmissions = S.Config.flavor.app.list_enabled !== false,
// will be "mobile" or "desktop", as defined in default.css
layout = window.getComputedStyle(document.body,':after').getPropertyValue('content'),
onPlaceFound, onPlaceNotFound, modelId;

onPlaceFound = function(model) {
Expand All @@ -397,7 +399,7 @@ var Shareabouts = Shareabouts || {};
}

self.$panel.removeClass().addClass('place-detail place-detail-' + model.id);
self.showPanel(placeDetailView.render().$el, true);
self.showPanel(placeDetailView.render().$el, !!responseId);
self.hideNewPin();
self.destroyNewModels();
self.hideCenterPoint();
Expand All @@ -422,7 +424,13 @@ var Shareabouts = Shareabouts || {};

// call scrollIntoView()
if ($responseToScrollTo.length > 0) {
$responseToScrollTo.get(0).scrollIntoView();
if (layout === 'desktop') {
// For desktop, the panel content is scrollable
self.$panelContent.scrollTo($responseToScrollTo, 500);
} else {
// For mobile, it's the window
$(window).scrollTo($responseToScrollTo, 500);
}
}
}

Expand Down Expand Up @@ -484,11 +492,17 @@ var Shareabouts = Shareabouts || {};
this.$panelContent.html(markup);
this.$panel.show();

if (preventScrollToTop) {
this.$panelContent.scrollTop(0);
// Scroll to the top of window when showing new content on mobile. Does
// nothing on desktop.
window.scrollTo(0, 0);
if (!preventScrollToTop) {
// will be "mobile" or "desktop", as defined in default.css
var layout = window.getComputedStyle(document.body,':after').getPropertyValue('content');
if (layout === 'desktop') {
// For desktop, the panel content is scrollable
this.$panelContent.scrollTo(0, 0);
} else {
// Scroll to the top of window when showing new content on mobile. Does
// nothing on desktop. (Except when embedded in a scrollable site.)
window.scrollTo(0, 0);
}
}

$('body').addClass('content-visible');
Expand Down
12 changes: 10 additions & 2 deletions src/sa_web/static/js/views/survey-view.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ var Shareabouts = Shareabouts || {};
responses = [],
url = window.location.toString(),
urlParts = url.split('response/'),
// will be "mobile" or "desktop", as defined in default.css
layout = window.getComputedStyle(document.body,':after').getPropertyValue('content'),
responseIdToScrollTo,
$responseToScrollTo;

Expand Down Expand Up @@ -58,8 +60,14 @@ var Shareabouts = Shareabouts || {};
// call scrollIntoView()
if ($responseToScrollTo.length > 0) {
setTimeout(function() {
$responseToScrollTo.get(0).scrollIntoView();
}, 500);
// For desktop, the panel content is scrollable
if (layout === 'desktop') {
$('#content article').scrollTo($responseToScrollTo);
} else {
// For mobile, it's the window
$(window).scrollTo($responseToScrollTo);
}
}, 700);
}

return this;
Expand Down
186 changes: 186 additions & 0 deletions src/sa_web/static/libs/jquery.scrollTo.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
/*!
* jQuery.ScrollTo
* Copyright (c) 2007-2014 Ariel Flesler - aflesler<a>gmail<d>com | http://flesler.blogspot.com
* Licensed under MIT
* http://flesler.blogspot.com/2007/10/jqueryscrollto.html
* @projectDescription Easy element scrolling using jQuery.
* @author Ariel Flesler
* @version 1.4.12
*/

;(function(plugin) {
// AMD Support
if (typeof define === 'function' && define.amd) {
define(['jquery'], plugin);
} else {
plugin(jQuery);
}
}(function($) {

var $scrollTo = $.scrollTo = function( target, duration, settings ) {
return $(window).scrollTo( target, duration, settings );
};

$scrollTo.defaults = {
axis:'xy',
duration: parseFloat($.fn.jquery) >= 1.3 ? 0 : 1,
limit:true
};

// Returns the element that needs to be animated to scroll the window.
// Kept for backwards compatibility (specially for localScroll & serialScroll)
$scrollTo.window = function( scope ) {
return $(window)._scrollable();
};

// Hack, hack, hack :)
// Returns the real elements to scroll (supports window/iframes, documents and regular nodes)
$.fn._scrollable = function() {
return this.map(function() {
var elem = this,
isWin = !elem.nodeName || $.inArray( elem.nodeName.toLowerCase(), ['iframe','#document','html','body'] ) != -1;

if (!isWin)
return elem;

var doc = (elem.contentWindow || elem).document || elem.ownerDocument || elem;

return /webkit/i.test(navigator.userAgent) || doc.compatMode == 'BackCompat' ?
doc.body :
doc.documentElement;
});
};

$.fn.scrollTo = function( target, duration, settings ) {
if (typeof duration == 'object') {
settings = duration;
duration = 0;
}
if (typeof settings == 'function')
settings = { onAfter:settings };

if (target == 'max')
target = 9e9;

settings = $.extend( {}, $scrollTo.defaults, settings );
// Speed is still recognized for backwards compatibility
duration = duration || settings.duration;
// Make sure the settings are given right
settings.queue = settings.queue && settings.axis.length > 1;

if (settings.queue)
// Let's keep the overall duration
duration /= 2;
settings.offset = both( settings.offset );
settings.over = both( settings.over );

return this._scrollable().each(function() {
// Null target yields nothing, just like jQuery does
if (target == null) return;

var elem = this,
$elem = $(elem),
targ = target, toff, attr = {},
win = $elem.is('html,body');

switch (typeof targ) {
// A number will pass the regex
case 'number':
case 'string':
if (/^([+-]=?)?\d+(\.\d+)?(px|%)?$/.test(targ)) {
targ = both( targ );
// We are done
break;
}
// Relative/Absolute selector, no break!
targ = win ? $(targ) : $(targ, this);
if (!targ.length) return;
case 'object':
// DOMElement / jQuery
if (targ.is || targ.style)
// Get the real position of the target
toff = (targ = $(targ)).offset();
}

var offset = $.isFunction(settings.offset) && settings.offset(elem, targ) || settings.offset;

$.each( settings.axis.split(''), function( i, axis ) {
var Pos = axis == 'x' ? 'Left' : 'Top',
pos = Pos.toLowerCase(),
key = 'scroll' + Pos,
old = elem[key],
max = $scrollTo.max(elem, axis);

if (toff) {// jQuery / DOMElement
attr[key] = toff[pos] + ( win ? 0 : old - $elem.offset()[pos] );

// If it's a dom element, reduce the margin
if (settings.margin) {
attr[key] -= parseInt(targ.css('margin'+Pos)) || 0;
attr[key] -= parseInt(targ.css('border'+Pos+'Width')) || 0;
}

attr[key] += offset[pos] || 0;

if(settings.over[pos])
// Scroll to a fraction of its width/height
attr[key] += targ[axis=='x'?'width':'height']() * settings.over[pos];
} else {
var val = targ[pos];
// Handle percentage values
attr[key] = val.slice && val.slice(-1) == '%' ?
parseFloat(val) / 100 * max
: val;
}

// Number or 'number'
if (settings.limit && /^\d+$/.test(attr[key]))
// Check the limits
attr[key] = attr[key] <= 0 ? 0 : Math.min( attr[key], max );

// Queueing axes
if (!i && settings.queue) {
// Don't waste time animating, if there's no need.
if (old != attr[key])
// Intermediate animation
animate( settings.onAfterFirst );
// Don't animate this axis again in the next iteration.
delete attr[key];
}
});

animate( settings.onAfter );

function animate( callback ) {
$elem.animate( attr, duration, settings.easing, callback && function() {
callback.call(this, targ, settings);
});
};

}).end();
};

// Max scrolling position, works on quirks mode
// It only fails (not too badly) on IE, quirks mode.
$scrollTo.max = function( elem, axis ) {
var Dim = axis == 'x' ? 'Width' : 'Height',
scroll = 'scroll'+Dim;

if (!$(elem).is('html,body'))
return elem[scroll] - $(elem)[Dim.toLowerCase()]();

var size = 'client' + Dim,
html = elem.ownerDocument.documentElement,
body = elem.ownerDocument.body;

return Math.max( html[scroll], body[scroll] )
- Math.min( html[size] , body[size] );
};

function both( val ) {
return $.isFunction(val) || typeof val == 'object' ? val : { top:val, left:val };
};

// AMD requirement
return $scrollTo;
}));
7 changes: 7 additions & 0 deletions src/sa_web/static/libs/jquery.scrollTo.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/sa_web/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ <h3>
<script src="{{settings.COMPRESS_URL}}libs/spin.min.js"></script>
<script src="{{settings.COMPRESS_URL}}libs/gatekeeper.js"></script>
<script src="{{settings.COMPRESS_URL}}libs/swag.min.js"></script>
<script src="{{settings.COMPRESS_URL}}libs/jquery.scrollTo.js"></script>

<script src="{{settings.COMPRESS_URL}}js/utils.js"></script>
<script src="{{settings.COMPRESS_URL}}js/template-helpers.js"></script>
Expand Down

0 comments on commit 8f3764c

Please sign in to comment.