/*! * Angular Material Design * https://github.com/angular/material * @license MIT * v1.1.3 */ goog.provide('ngmaterial.components.sticky'); goog.require('ngmaterial.components.content'); goog.require('ngmaterial.core'); /** * @ngdoc module * @name material.components.sticky * @description * Sticky effects for md * */ MdSticky['$inject'] = ["$mdConstant", "$$rAF", "$mdUtil", "$compile"]; angular .module('material.components.sticky', [ 'material.core', 'material.components.content' ]) .factory('$mdSticky', MdSticky); /** * @ngdoc service * @name $mdSticky * @module material.components.sticky * * @description * The `$mdSticky`service provides a mixin to make elements sticky. * * Whenever the current browser supports stickiness natively, the `$mdSticky` service will just * use the native browser stickiness. * * By default the `$mdSticky` service compiles the cloned element, when not specified through the `elementClone` * parameter, in the same scope as the actual element lives. * * *

Notes

* When using an element which is containing a compiled directive, which changed its DOM structure during compilation, * you should compile the clone yourself using the plain template.

* See the right usage below: * * angular.module('myModule') * .directive('stickySelect', function($mdSticky, $compile) { * var SELECT_TEMPLATE = * '' + * 'Option 1' + * ''; * * return { * restrict: 'E', * replace: true, * template: SELECT_TEMPLATE, * link: function(scope,element) { * $mdSticky(scope, element, $compile(SELECT_TEMPLATE)(scope)); * } * }; * }); * * * @usage * * angular.module('myModule') * .directive('stickyText', function($mdSticky, $compile) { * return { * restrict: 'E', * template: 'Sticky Text', * link: function(scope,element) { * $mdSticky(scope, element); * } * }; * }); * * * @returns A `$mdSticky` function that takes three arguments: * - `scope` * - `element`: The element that will be 'sticky' * - `elementClone`: A clone of the element, that will be shown * when the user starts scrolling past the original element. * If not provided, it will use the result of `element.clone()` and compiles it in the given scope. */ function MdSticky($mdConstant, $$rAF, $mdUtil, $compile) { var browserStickySupport = $mdUtil.checkStickySupport(); /** * Registers an element as sticky, used internally by directives to register themselves */ return function registerStickyElement(scope, element, stickyClone) { var contentCtrl = element.controller('mdContent'); if (!contentCtrl) return; if (browserStickySupport) { element.css({ position: browserStickySupport, top: 0, 'z-index': 2 }); } else { var $$sticky = contentCtrl.$element.data('$$sticky'); if (!$$sticky) { $$sticky = setupSticky(contentCtrl); contentCtrl.$element.data('$$sticky', $$sticky); } // Compile our cloned element, when cloned in this service, into the given scope. var cloneElement = stickyClone || $compile(element.clone())(scope); var deregister = $$sticky.add(element, cloneElement); scope.$on('$destroy', deregister); } }; function setupSticky(contentCtrl) { var contentEl = contentCtrl.$element; // Refresh elements is very expensive, so we use the debounced // version when possible. var debouncedRefreshElements = $$rAF.throttle(refreshElements); // setupAugmentedScrollEvents gives us `$scrollstart` and `$scroll`, // more reliable than `scroll` on android. setupAugmentedScrollEvents(contentEl); contentEl.on('$scrollstart', debouncedRefreshElements); contentEl.on('$scroll', onScroll); var self; return self = { prev: null, current: null, //the currently stickied item next: null, items: [], add: add, refreshElements: refreshElements }; /*************** * Public ***************/ // Add an element and its sticky clone to this content's sticky collection function add(element, stickyClone) { stickyClone.addClass('md-sticky-clone'); var item = { element: element, clone: stickyClone }; self.items.push(item); $mdUtil.nextTick(function() { contentEl.prepend(item.clone); }); debouncedRefreshElements(); return function remove() { self.items.forEach(function(item, index) { if (item.element[0] === element[0]) { self.items.splice(index, 1); item.clone.remove(); } }); debouncedRefreshElements(); }; } function refreshElements() { // Sort our collection of elements by their current position in the DOM. // We need to do this because our elements' order of being added may not // be the same as their order of display. self.items.forEach(refreshPosition); self.items = self.items.sort(function(a, b) { return a.top < b.top ? -1 : 1; }); // Find which item in the list should be active, // based upon the content's current scroll position var item; var currentScrollTop = contentEl.prop('scrollTop'); for (var i = self.items.length - 1; i >= 0; i--) { if (currentScrollTop > self.items[i].top) { item = self.items[i]; break; } } setCurrentItem(item); } /*************** * Private ***************/ // Find the `top` of an item relative to the content element, // and also the height. function refreshPosition(item) { // Find the top of an item by adding to the offsetHeight until we reach the // content element. var current = item.element[0]; item.top = 0; item.left = 0; item.right = 0; while (current && current !== contentEl[0]) { item.top += current.offsetTop; item.left += current.offsetLeft; if ( current.offsetParent ){ item.right += current.offsetParent.offsetWidth - current.offsetWidth - current.offsetLeft; //Compute offsetRight } current = current.offsetParent; } item.height = item.element.prop('offsetHeight'); var defaultVal = $mdUtil.floatingScrollbars() ? '0' : undefined; $mdUtil.bidi(item.clone, 'margin-left', item.left, defaultVal); $mdUtil.bidi(item.clone, 'margin-right', defaultVal, item.right); } // As we scroll, push in and select the correct sticky element. function onScroll() { var scrollTop = contentEl.prop('scrollTop'); var isScrollingDown = scrollTop > (onScroll.prevScrollTop || 0); // Store the previous scroll so we know which direction we are scrolling onScroll.prevScrollTop = scrollTop; // // AT TOP (not scrolling) // if (scrollTop === 0) { // If we're at the top, just clear the current item and return setCurrentItem(null); return; } // // SCROLLING DOWN (going towards the next item) // if (isScrollingDown) { // If we've scrolled down past the next item's position, sticky it and return if (self.next && self.next.top <= scrollTop) { setCurrentItem(self.next); return; } // If the next item is close to the current one, push the current one up out of the way if (self.current && self.next && self.next.top - scrollTop <= self.next.height) { translate(self.current, scrollTop + (self.next.top - self.next.height - scrollTop)); return; } } // // SCROLLING UP (not at the top & not scrolling down; must be scrolling up) // if (!isScrollingDown) { // If we've scrolled up past the previous item's position, sticky it and return if (self.current && self.prev && scrollTop < self.current.top) { setCurrentItem(self.prev); return; } // If the next item is close to the current one, pull the current one down into view if (self.next && self.current && (scrollTop >= (self.next.top - self.current.height))) { translate(self.current, scrollTop + (self.next.top - scrollTop - self.current.height)); return; } } // // Otherwise, just move the current item to the proper place (scrolling up or down) // if (self.current) { translate(self.current, scrollTop); } } function setCurrentItem(item) { if (self.current === item) return; // Deactivate currently active item if (self.current) { translate(self.current, null); setStickyState(self.current, null); } // Activate new item if given if (item) { setStickyState(item, 'active'); } self.current = item; var index = self.items.indexOf(item); // If index === -1, index + 1 = 0. It works out. self.next = self.items[index + 1]; self.prev = self.items[index - 1]; setStickyState(self.next, 'next'); setStickyState(self.prev, 'prev'); } function setStickyState(item, state) { if (!item || item.state === state) return; if (item.state) { item.clone.attr('sticky-prev-state', item.state); item.element.attr('sticky-prev-state', item.state); } item.clone.attr('sticky-state', state); item.element.attr('sticky-state', state); item.state = state; } function translate(item, amount) { if (!item) return; if (amount === null || amount === undefined) { if (item.translateY) { item.translateY = null; item.clone.css($mdConstant.CSS.TRANSFORM, ''); } } else { item.translateY = amount; $mdUtil.bidi( item.clone, $mdConstant.CSS.TRANSFORM, 'translate3d(' + item.left + 'px,' + amount + 'px,0)', 'translateY(' + amount + 'px)' ); } } } // Android 4.4 don't accurately give scroll events. // To fix this problem, we setup a fake scroll event. We say: // > If a scroll or touchmove event has happened in the last DELAY milliseconds, // then send a `$scroll` event every animationFrame. // Additionally, we add $scrollstart and $scrollend events. function setupAugmentedScrollEvents(element) { var SCROLL_END_DELAY = 200; var isScrolling; var lastScrollTime; element.on('scroll touchmove', function() { if (!isScrolling) { isScrolling = true; $$rAF.throttle(loopScrollEvent); element.triggerHandler('$scrollstart'); } element.triggerHandler('$scroll'); lastScrollTime = +$mdUtil.now(); }); function loopScrollEvent() { if (+$mdUtil.now() - lastScrollTime > SCROLL_END_DELAY) { isScrolling = false; element.triggerHandler('$scrollend'); } else { element.triggerHandler('$scroll'); $$rAF.throttle(loopScrollEvent); } } } } ngmaterial.components.sticky = angular.module("material.components.sticky");