<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[30388] trunk/src/wp-content/themes/twentyfifteen/js/functions.js: Twenty Fifteen: Making the sidebar sticky for everyone.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/30388">30388</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/30388","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandstewart</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-11-19 18:22:15 +0000 (Wed, 19 Nov 2014)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Twenty Fifteen: Making the sidebar sticky for everyone. When we have a long sidebar, let it scroll with the content, but fixing the sidebar and no longer scrolling when we get to the end of the sidebar content. Scroll up and the sidebar starts scrolling up to, eventually staying fixed when it gets back to the top.
Props celloexpressions, avryl, fixes <a href="https://core.trac.wordpress.org/ticket/30366">#30366</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpcontentthemestwentyfifteenjsfunctionsjs">trunk/src/wp-content/themes/twentyfifteen/js/functions.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpcontentthemestwentyfifteenjsfunctionsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-content/themes/twentyfifteen/js/functions.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-content/themes/twentyfifteen/js/functions.js 2014-11-19 18:11:39 UTC (rev 30387)
+++ trunk/src/wp-content/themes/twentyfifteen/js/functions.js 2014-11-19 18:22:15 UTC (rev 30388)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,7 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> ( function( $ ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var $body, $window, sidebar, toolbarOffset;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var $body, $window, $document, $sidebar, adminbarOffset, top = false,
+ bottom = false, windowWidth, windowHeight, lastWindowPos = 0,
+ topOffset = 0, documentHeight, sidebarWidth, sidebarHeight, resizeTimer;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add dropdown toggle that display child menu items.
</span><span class="cx" style="display: block; padding: 0 10px"> $( '.main-navigation .page_item_has_children > a, .main-navigation .menu-item-has-children > a' ).after( '<button class="dropdown-toggle" aria-expanded="false">' + screenReaderText.expand + '</button>' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,7 +34,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Hide button if there is no widgets and menu is missing or empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Hide button if there are no widgets and the menus are missing or empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> menu = secondary.find( '.nav-menu' );
</span><span class="cx" style="display: block; padding: 0 10px"> widgets = secondary.find( '#widget-area' );
</span><span class="cx" style="display: block; padding: 0 10px"> social = secondary.find( '#social-navigation' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,47 +50,81 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px"> } )();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Sidebar scrolling.
+ function resize() {
+ windowWidth = $window.width();
+ windowHeight = $window.height();
+ documentHeight = $document.height();
+ sidebarHeight = $sidebar.height();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Sidebar (un)fixing: fix when short, un-fix when scroll needed
- function fixedOrScrolledSidebar() {
- if ( $window.width() >= 955 ) {
- if ( sidebar.scrollHeight < ( $window.height() - toolbarOffset ) ) {
- $body.addClass( 'sidebar-fixed' );
- } else {
- $body.removeClass( 'sidebar-fixed' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 955 >= windowWidth ) {
+ top = bottom = false;
+ $sidebar.removeAttr( 'style' );
+ }
+ }
+
+ function scroll() {
+ var windowPos = $window.scrollTop();
+
+ if ( 955 <= windowWidth && sidebarHeight + adminbarOffset < documentHeight ) {
+ if ( sidebarHeight + adminbarOffset > windowHeight ) {
+ if ( windowPos > lastWindowPos ) {
+ if ( top ) {
+ top = false;
+ topOffset = ( $sidebar.offset().top > 0 ) ? $sidebar.offset().top - adminbarOffset : 0;
+ $sidebar.attr( 'style', 'top: ' + topOffset + 'px;' );
+ } else if ( ! bottom && windowPos + windowHeight > sidebarHeight + $sidebar.offset().top ) {
+ bottom = true;
+ $sidebar.attr( 'style', 'position: fixed;bottom: 0;' );
+ }
+ } else if ( windowPos < lastWindowPos ) {
+ if ( bottom ) {
+ bottom = false;
+ topOffset = ( $sidebar.offset().top > 0 ) ? $sidebar.offset().top - adminbarOffset : 0;
+ $sidebar.attr( 'style', 'top: ' + topOffset + 'px;' );
+ } else if ( ! top && windowPos + adminbarOffset < $sidebar.offset().top ) {
+ top = true;
+ $sidebar.attr( 'style', 'position: fixed;' );
+ }
+ } else {
+ top = bottom = false;
+ topOffset = ( $sidebar.offset().top > 0 ) ? $sidebar.offset().top - adminbarOffset : 0;
+ $sidebar.attr( 'style', 'top: ' + topOffset + 'px;' );
+ }
+ } else if ( ! top ) {
+ top = true;
+ $sidebar.attr( 'style', 'position: fixed;' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
- $body.removeClass( 'sidebar-fixed' );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ lastWindowPos = windowPos;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function debouncedFixedOrScrolledSidebar() {
- var timeout;
- return function() {
- clearTimeout( timeout );
- timeout = setTimeout( function() {
- timeout = null;
- fixedOrScrolledSidebar();
- }, 150 );
- };
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function resizeAndScroll() {
+ resize();
+ scroll();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $( document ).ready( function() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // But! We only want to allow fixed sidebars when there are no submenus.
- if ( $( '#site-navigation .sub-menu' ).length ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $body = $( 'body' );
+ $window = $( window );
+ $document = $( document );
+ $sidebar = $( '#sidebar' ).first();
+ adminbarOffset = $body.is( '.admin-bar' ) ? $( '#wpadminbar' ).height() : 0;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // only initialize 'em if we need 'em
- $body = $( 'body' );
- $window = $( window );
- sidebar = $( '#sidebar' )[0];
- toolbarOffset = $body.is( '.admin-bar' ) ? $( '#wpadminbar' ).height() : 0;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $window
+ .on( 'scroll.twentyfifteen', scroll )
+ .on( 'resize.twentyfifteen', function() {
+ clearTimeout( resizeTimer );
+ resizeTimer = setTimeout( resizeAndScroll, 500 );
+ } );
+ $sidebar.on( 'click keydown', 'button', resizeAndScroll );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $window
- .on( 'load.twentyfifteen', fixedOrScrolledSidebar )
- .on( 'resize.twentyfifteen', debouncedFixedOrScrolledSidebar() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ resizeAndScroll();
+
+ for ( var i = 1; i < 6; i++ ) {
+ setTimeout( resizeAndScroll, 100 * i );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> } )( jQuery );
</span><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>