ngx-hide-on-scroll
Version:
Hide an element on scroll down or up in Angular.
495 lines (484 loc) • 22.9 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@angular/core'), require('rxjs'), require('rxjs/operators'), require('@angular/common')) :
typeof define === 'function' && define.amd ? define('ngx-hide-on-scroll', ['exports', '@angular/core', 'rxjs', 'rxjs/operators', '@angular/common'], factory) :
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global['ngx-hide-on-scroll'] = {}, global.ng.core, global.rxjs, global.rxjs.operators, global.ng.common));
}(this, (function (exports, core, rxjs, operators, common) { 'use strict';
/*! *****************************************************************************
Copyright (c) Microsoft Corporation.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
***************************************************************************** */
/* global Reflect, Promise */
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b)
if (Object.prototype.hasOwnProperty.call(b, p))
d[p] = b[p]; };
return extendStatics(d, b);
};
function __extends(d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
}
var __assign = function () {
__assign = Object.assign || function __assign(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s)
if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
function __rest(s, e) {
var t = {};
for (var p in s)
if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
}
function __decorate(decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
r = Reflect.decorate(decorators, target, key, desc);
else
for (var i = decorators.length - 1; i >= 0; i--)
if (d = decorators[i])
r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
}
function __param(paramIndex, decorator) {
return function (target, key) { decorator(target, key, paramIndex); };
}
function __metadata(metadataKey, metadataValue) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function")
return Reflect.metadata(metadataKey, metadataValue);
}
function __awaiter(thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try {
step(generator.next(value));
}
catch (e) {
reject(e);
} }
function rejected(value) { try {
step(generator["throw"](value));
}
catch (e) {
reject(e);
} }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
}
function __generator(thisArg, body) {
var _ = { label: 0, sent: function () { if (t[0] & 1)
throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function () { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f)
throw new TypeError("Generator is already executing.");
while (_)
try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done)
return t;
if (y = 0, t)
op = [op[0] & 2, t.value];
switch (op[0]) {
case 0:
case 1:
t = op;
break;
case 4:
_.label++;
return { value: op[1], done: false };
case 5:
_.label++;
y = op[1];
op = [0];
continue;
case 7:
op = _.ops.pop();
_.trys.pop();
continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
_ = 0;
continue;
}
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) {
_.label = op[1];
break;
}
if (op[0] === 6 && _.label < t[1]) {
_.label = t[1];
t = op;
break;
}
if (t && _.label < t[2]) {
_.label = t[2];
_.ops.push(op);
break;
}
if (t[2])
_.ops.pop();
_.trys.pop();
continue;
}
op = body.call(thisArg, _);
}
catch (e) {
op = [6, e];
y = 0;
}
finally {
f = t = 0;
}
if (op[0] & 5)
throw op[1];
return { value: op[0] ? op[1] : void 0, done: true };
}
}
var __createBinding = Object.create ? (function (o, m, k, k2) {
if (k2 === undefined)
k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function () { return m[k]; } });
}) : (function (o, m, k, k2) {
if (k2 === undefined)
k2 = k;
o[k2] = m[k];
});
function __exportStar(m, o) {
for (var p in m)
if (p !== "default" && !Object.prototype.hasOwnProperty.call(o, p))
__createBinding(o, m, p);
}
function __values(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m)
return m.call(o);
if (o && typeof o.length === "number")
return {
next: function () {
if (o && i >= o.length)
o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
}
function __read(o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m)
return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done)
ar.push(r.value);
}
catch (error) {
e = { error: error };
}
finally {
try {
if (r && !r.done && (m = i["return"]))
m.call(i);
}
finally {
if (e)
throw e.error;
}
}
return ar;
}
/** @deprecated */
function __spread() {
for (var ar = [], i = 0; i < arguments.length; i++)
ar = ar.concat(__read(arguments[i]));
return ar;
}
/** @deprecated */
function __spreadArrays() {
for (var s = 0, i = 0, il = arguments.length; i < il; i++)
s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
}
function __spreadArray(to, from) {
for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
to[j] = from[i];
return to;
}
function __await(v) {
return this instanceof __await ? (this.v = v, this) : new __await(v);
}
function __asyncGenerator(thisArg, _arguments, generator) {
if (!Symbol.asyncIterator)
throw new TypeError("Symbol.asyncIterator is not defined.");
var g = generator.apply(thisArg, _arguments || []), i, q = [];
return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
function verb(n) { if (g[n])
i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
function resume(n, v) { try {
step(g[n](v));
}
catch (e) {
settle(q[0][3], e);
} }
function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
function fulfill(value) { resume("next", value); }
function reject(value) { resume("throw", value); }
function settle(f, v) { if (f(v), q.shift(), q.length)
resume(q[0][0], q[0][1]); }
}
function __asyncDelegator(o) {
var i, p;
return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === "return" } : f ? f(v) : v; } : f; }
}
function __asyncValues(o) {
if (!Symbol.asyncIterator)
throw new TypeError("Symbol.asyncIterator is not defined.");
var m = o[Symbol.asyncIterator], i;
return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
function settle(resolve, reject, d, v) { Promise.resolve(v).then(function (v) { resolve({ value: v, done: d }); }, reject); }
}
function __makeTemplateObject(cooked, raw) {
if (Object.defineProperty) {
Object.defineProperty(cooked, "raw", { value: raw });
}
else {
cooked.raw = raw;
}
return cooked;
}
;
var __setModuleDefault = Object.create ? (function (o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function (o, v) {
o["default"] = v;
};
function __importStar(mod) {
if (mod && mod.__esModule)
return mod;
var result = {};
if (mod != null)
for (var k in mod)
if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
__createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
}
function __importDefault(mod) {
return (mod && mod.__esModule) ? mod : { default: mod };
}
function __classPrivateFieldGet(receiver, privateMap) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to get private field on non-instance");
}
return privateMap.get(receiver);
}
function __classPrivateFieldSet(receiver, privateMap, value) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to set private field on non-instance");
}
privateMap.set(receiver, value);
return value;
}
// Inspired by: https://netbasal.com/reactive-sticky-header-in-angular-12dbffb3f1d3
/**
* The `ngxHideOnScroll` directive allows you to hide an html element (e.g. navbar) on scroll down and show it again on scroll up.
*/
var NgxHideOnScrollDirective = /** @class */ (function () {
function NgxHideOnScrollDirective(elementRef, renderer2, platformId) {
this.elementRef = elementRef;
this.renderer2 = renderer2;
this.platformId = platformId;
/**
* `'Down'`: The element will be hidden on scroll down and it will be shown again on scroll up.<br/>`Up`: The element will be hidden on scroll up and it will be shown again on scroll down.
*/
this.hideOnScroll = 'Down';
/**
* CSS class name added to the element to hide it. When this property is set, `propertyUsedToHide`, `valueWhenHidden`, and `valueWhenShown` have not effect.
*/
this.classNameWhenHidden = '';
/**
* The CSS property used to hide/show the element.
*
* @default
* 'transform'
*/
this.propertyUsedToHide = 'transform';
/**
* The value of `propertyUsedToHide` when the element is hidden.
*
* @default
* 'translateY(-100%)'
*/
this.valueWhenHidden = 'translateY(-100%)';
/**
* The value of `propertyUsedToHide` when the element is shown.
*
* @default
* 'translateY(0)'
*/
this.valueWhenShown = 'translateY(0)';
/**
* The selector of the element you want to listen the scroll event, in case it is not the default browser scrolling element (`document.scrollingElement` or `document.documentElement`). For example [` .mat-sidenav-content`]( https://stackoverflow.com/a/52931772/12954396) if you are using [Angular Material Sidenav]( https://material.angular.io/components/sidenav)
*/
this.scrollingElementSelector = '';
/**
* Emitted when the element is hidden.
*/
this.eventElementHidden = new core.EventEmitter();
/**
* Emitted when the element is shown.
*/
this.eventElementShown = new core.EventEmitter();
this.unsubscribeNotifier = new rxjs.Subject();
}
NgxHideOnScrollDirective.prototype.ngAfterViewInit = function () {
var _this = this;
if (common.isPlatformServer(this.platformId)) {
return;
}
var elementToListenScrollEvent;
var scrollingElement;
if (!this.scrollingElementSelector) {
elementToListenScrollEvent = window;
scrollingElement = this.getDefaultScrollingElement();
}
else {
scrollingElement = document.querySelector(this.scrollingElementSelector);
if (!scrollingElement) {
console.error("NgxHideOnScroll: @Input() scrollingElementSelector\nElement with selector: \"" + this.scrollingElementSelector + "\" not found.");
return;
}
elementToListenScrollEvent = scrollingElement;
}
var scroll$ = rxjs.fromEvent(elementToListenScrollEvent, 'scroll').pipe(operators.takeUntil(this.unsubscribeNotifier), operators.throttleTime(50), // only emit every 50 ms
operators.map(function () { return scrollingElement.scrollTop; }), // get vertical scroll position
operators.pairwise(), // look at this and the last emitted element
// compare this and the last element to figure out scrolling direction
operators.map(function (_a) {
var _b = __read(_a, 2), y1 = _b[0], y2 = _b[1];
return (y2 < y1 ? ScrollDirection.Up : ScrollDirection.Down);
}), operators.distinctUntilChanged(), // only emit when scrolling direction changed
operators.share() // share a single subscription to the underlying sequence in case of multiple subscribers
);
var scrollUp$ = scroll$.pipe(operators.filter(function (direction) { return direction === ScrollDirection.Up; }));
var scrollDown$ = scroll$.pipe(operators.filter(function (direction) { return direction === ScrollDirection.Down; }));
var scrollUpAction;
var scrollDownAction;
if (this.hideOnScroll === 'Up') {
scrollUpAction = function () { return _this.hideElement(); };
scrollDownAction = function () { return _this.showElement(); };
}
else {
scrollUpAction = function () { return _this.showElement(); };
scrollDownAction = function () { return _this.hideElement(); };
}
scrollUp$.subscribe(function () { return scrollUpAction(); });
scrollDown$.subscribe(function () { return scrollDownAction(); });
};
NgxHideOnScrollDirective.prototype.ngOnDestroy = function () {
this.unsubscribeNotifier.next();
this.unsubscribeNotifier.complete();
};
NgxHideOnScrollDirective.prototype.hideElement = function () {
var nativeElement = this.elementRef.nativeElement;
if (this.classNameWhenHidden) {
this.renderer2.addClass(nativeElement, this.classNameWhenHidden);
}
else {
this.renderer2.setStyle(nativeElement, this.propertyUsedToHide, this.valueWhenHidden);
}
this.eventElementHidden.emit();
};
NgxHideOnScrollDirective.prototype.showElement = function () {
var nativeElement = this.elementRef.nativeElement;
if (this.classNameWhenHidden) {
this.renderer2.removeClass(nativeElement, this.classNameWhenHidden);
}
else {
this.renderer2.setStyle(nativeElement, this.propertyUsedToHide, this.valueWhenShown);
}
this.eventElementShown.emit();
};
NgxHideOnScrollDirective.prototype.getDefaultScrollingElement = function () {
return (document.scrollingElement || document.documentElement);
};
return NgxHideOnScrollDirective;
}());
NgxHideOnScrollDirective.decorators = [
{ type: core.Directive, args: [{
selector: '[ngxHideOnScroll]'
},] }
];
NgxHideOnScrollDirective.ctorParameters = function () { return [
{ type: core.ElementRef },
{ type: core.Renderer2 },
{ type: String, decorators: [{ type: core.Inject, args: [core.PLATFORM_ID,] }] }
]; };
NgxHideOnScrollDirective.propDecorators = {
hideOnScroll: [{ type: core.Input }],
classNameWhenHidden: [{ type: core.Input }],
propertyUsedToHide: [{ type: core.Input }],
valueWhenHidden: [{ type: core.Input }],
valueWhenShown: [{ type: core.Input }],
scrollingElementSelector: [{ type: core.Input }],
eventElementHidden: [{ type: core.Output }],
eventElementShown: [{ type: core.Output }]
};
var ScrollDirection;
(function (ScrollDirection) {
ScrollDirection["Up"] = "Up";
ScrollDirection["Down"] = "Down";
})(ScrollDirection || (ScrollDirection = {}));
var NgxHideOnScrollModule = /** @class */ (function () {
function NgxHideOnScrollModule() {
}
return NgxHideOnScrollModule;
}());
NgxHideOnScrollModule.decorators = [
{ type: core.NgModule, args: [{
declarations: [NgxHideOnScrollDirective],
imports: [],
exports: [NgxHideOnScrollDirective]
},] }
];
/*
* Public API Surface of ngx-hide-on-scroll
*/
/**
* Generated bundle index. Do not edit.
*/
exports.NgxHideOnScrollDirective = NgxHideOnScrollDirective;
exports.NgxHideOnScrollModule = NgxHideOnScrollModule;
Object.defineProperty(exports, '__esModule', { value: true });
})));
//# sourceMappingURL=ngx-hide-on-scroll.umd.js.map