@jood/appearer
Version:
javascript intersection observer
682 lines (669 loc) • 26.9 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('intersection-observer'), require('rxjs')) :
typeof define === 'function' && define.amd ? define('@jood/appearer', ['exports', 'intersection-observer', 'rxjs'], factory) :
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global.jood = global.jood || {}, global.jood.appearer = {}), null, global.rxjs));
})(this, (function (exports, intersectionObserver, rxjs) { 'use strict';
/**
* 화면(지정된 root 영역)에 진입 여부를 판단하고 알리기 위한 클래스.
* 등록된 Actor(s)를 IntersectionObserver 를 통해 관찰하고 관찰된 상태에 따라 Actor 에게 알림.
* @template T Actor
*/
var AppearStage = /** @class */ (function () {
function AppearStage() {
}
/**
* 초기화
* @param [option] 초기 옵션. 인터섹션 옵저버는 생성시에만 옵션 지정이 가능
*/
AppearStage.prototype.init = function (option) {
if (option === void 0) { option = {}; }
if (!this.observer) {
this.actorMap = new Map();
this.observer = new IntersectionObserver(this.onObserveEntries.bind(this), option);
}
};
/**
* 전달된 actor 를 옵저버에 등록합니다.
* @param actor 등록할 Actor
*/
AppearStage.prototype.observe = function (actor) {
var element = actor.element;
if (this.actorMap && !this.actorMap.has(element)) {
actor.bind(this);
this.actorMap.set(element, actor);
this.intersectionObserver.observe(element);
}
};
/**
* 전달된 actor 를 옵저버에서 제외합니다.
* @param actor 제외할 Actor
*/
AppearStage.prototype.unobserve = function (actor) {
var element = actor.element;
if (this.actorMap && this.actorMap.has(element)) {
this.actorMap.delete(element);
this.intersectionObserver.unobserve(element);
}
};
Object.defineProperty(AppearStage.prototype, "actorSize", {
/**
* 옵저버에 등록(관찰) 중 인 Actor 의 수
*/
get: function () {
return this.actorMap ? this.actorMap.size : 0;
},
enumerable: false,
configurable: true
});
/**
* 등록 되어있는 Actor 를 반환 합니다.
* @returns T[]
*/
AppearStage.prototype.getActors = function () {
return Array.from(this.actorMap ? this.actorMap.values() : []);
};
Object.defineProperty(AppearStage.prototype, "intersectionObserver", {
/**
* 생성된 intersection observer 인스턴스
*/
get: function () {
if (!this.observer)
throw new Error("uninitialize");
return this.observer;
},
enumerable: false,
configurable: true
});
/**
* 옵저버의 콜백 핸들러
* @param entries 옵저버의 콜백으로 전달받는 엔트리 값
*/
AppearStage.prototype.onObserveEntries = function (entries) {
var _this = this;
entries.forEach(function (entry) {
if (!_this.actorMap)
return;
var isIntersecting = entry.isIntersecting, target = entry.target;
var actor = _this.actorMap.get(target);
if (actor) {
if (isIntersecting) {
actor.appear(entry);
}
else {
actor.disappear(entry);
}
}
});
};
/**
* 파기
*/
AppearStage.prototype.dispose = function () {
if (this.observer) {
this.observer.disconnect();
this.observer = null;
}
if (this.actorMap) {
this.actorMap.clear();
this.actorMap = null;
}
};
return AppearStage;
}());
/**
* Actor type 구분
* @export
* @enum {number}
*/
exports.AppearType = void 0;
(function (AppearType) {
AppearType["BASE"] = "base";
AppearType["ONCE"] = "once";
AppearType["LAZY"] = "lazy";
})(exports.AppearType || (exports.AppearType = {}));
/**
* 관찰대상의 이벤트
* @implements {AppearEventData<T>}
* @template T
*/
var AppearEvent = /** @class */ (function () {
/**
* @param type 이벤트 타입
* @param option 이벤트 데이터
*/
function AppearEvent(type, option) {
var actor = option.actor, entry = option.entry;
this.type = type;
this.actor = actor;
this.entry = entry;
}
return AppearEvent;
}());
/**
* 이벤트 타입 - 진입
*/
AppearEvent.APPEAR = "APPEAR";
/**
* 이벤트 타입 - 이탈
*/
AppearEvent.DISAPPEAR = "DISAPPEAR";
/**
* Stage 에 등록될 Actor.
* 스테이지에 진입, 이탈 시 계속 알려주는 기본형.
* @class BaseActor
* @implements {IActor}
*/
var BaseActor = /** @class */ (function () {
/**
* @param element 옵저버에 등록되어야 하는 native element
*/
function BaseActor(element) {
/**
* 이벤트 Observable
* @see https://rxjs-dev.firebaseapp.com/guide/subject
*/
this.events = new rxjs.Subject();
/**
* 현재 진입 여부 상태
*/
this.isAppear = null;
this.element = element;
}
/**
* 해당 인스턴스를 관찰하는 스테이지를 연결
* @param stage 스테이지
*/
BaseActor.prototype.bind = function (stage) {
this.stage = stage;
};
/**
* 진입, 이탈 등 이벤트 알림
* @param type 이벤트 타입
* @param [entry] 상태 변경시 관찰된 상태
*/
BaseActor.prototype.dispatch = function (type, entry) {
this.events.next(new AppearEvent(type, {
actor: this,
entry: entry,
}));
};
/**
* 스테이지 진입
* @param [entry] 스테이지 진입시 관찰 상태
*/
BaseActor.prototype.appear = function (entry) {
if (this.isAppear === true)
return;
this.isAppear = true;
this.dispatch(AppearEvent.APPEAR, entry);
};
/**
* 스테이지 이탈
* @param [entry] 스테이지 이탈시 관찰 상태
*/
BaseActor.prototype.disappear = function (entry) {
if (this.isAppear === false)
return;
this.isAppear = false;
this.dispatch(AppearEvent.DISAPPEAR, entry);
};
/**
* 파기
*/
BaseActor.prototype.dispose = function () {
if (this.stage) {
this.stage.unobserve(this);
}
};
return BaseActor;
}());
/******************************************************************************
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 (g && (g = 0, op[0] && (_ = 0)), _)
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;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function () { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (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, pack) {
if (pack || arguments.length === 2)
for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar)
ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
}
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, state, kind, f) {
if (kind === "a" && !f)
throw new TypeError("Private accessor was defined without a getter");
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver))
throw new TypeError("Cannot read private member from an object whose class did not declare it");
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
}
function __classPrivateFieldSet(receiver, state, value, kind, f) {
if (kind === "m")
throw new TypeError("Private method is not writable");
if (kind === "a" && !f)
throw new TypeError("Private accessor was defined without a setter");
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver))
throw new TypeError("Cannot write private member to an object whose class did not declare it");
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
}
function __classPrivateFieldIn(state, receiver) {
if (receiver === null || (typeof receiver !== "object" && typeof receiver !== "function"))
throw new TypeError("Cannot use 'in' operator on non-object");
return typeof state === "function" ? receiver === state : state.has(receiver);
}
/**
* Stage 에 등록될 Actor.
* 스테이지 진입을 한번만 감지한 후 본인 스스로 관찰 해제하는 감지형.
* (사용 예: 화면 진입시 한번만 애니메이션 한다, 이미지 로드를 한다)
* @class OnceActor
* @extends {BaseActor}
*/
var OnceActor = /** @class */ (function (_super) {
__extends(OnceActor, _super);
function OnceActor() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* 스테이지 진입. 진입시 자동 관찰 해제.
* @override
* @param [entry]
*/
OnceActor.prototype.appear = function (entry) {
if (this.isAppear === true)
return;
this.isAppear = true;
this.dispatch(AppearEvent.APPEAR, entry);
if (this.stage) {
this.stage.unobserve(this);
}
};
return OnceActor;
}(BaseActor));
/**
* Stage 에 등록될 Actor.
* 스테이지에 진입을 한번만 감지하되, 진입 후 너무 빠르게 이탈시에는 감지 처리를 하지 않는 느린 감지형.
* (사용 예: 촘촘한 상품 목록과 같이 빠르게 스크롤 하여 지나칠 수 있는 곳)
* @class LazyActor
* @extends {BaseActor}
*/
var LazyActor = /** @class */ (function (_super) {
__extends(LazyActor, _super);
function LazyActor() {
var _this = _super.apply(this, __spread(arguments)) || this;
_this.appearTimer = null;
_this.checkoutDelay = 1000;
_this.appearDelay = 150;
return _this;
}
/**
* 느린 감지를 시작하기 전 대기 시간.
* 지정된 시간 전에 감지된 진입은 느린 감지를 하지 않고 바로 진입을 알림.
* @param [delay=1000]
*/
LazyActor.prototype.setCheckoutDelay = function (delay) {
if (delay === void 0) { delay = 1000; }
this.checkoutDelay = delay;
};
/**
* 지정된 시간 사이에 진입 후 진출을 하는 경우 진입 알림을 하지 않는 대기 시간.
* @param [delay=150]
*/
LazyActor.prototype.setAppearDelay = function (delay) {
if (delay === void 0) { delay = 150; }
this.appearDelay = delay;
};
/**
* 진입 대기 타이머 파기
*/
LazyActor.prototype.clearAppearTimer = function () {
if (this.appearTimer) {
clearTimeout(this.appearTimer);
this.appearTimer = null;
}
};
/**
* 스테이지 진입. 진입 후 일정시간 (appearDelay) 전에 이탈하는 경우는 진입으로 취급하지 않음.
* @override
* @param [entry]
*/
LazyActor.prototype.appear = function (entry) {
var _this = this;
this.clearAppearTimer();
if (this.isAppear === true)
return;
if (this.checkoutDelay <= entry.time) {
this.appearTimer = setTimeout(function () {
_this.doAppear(entry);
}, this.appearDelay);
}
else {
this.doAppear(entry);
}
};
/**
* 실제 진입 처리.
* @private
* @param entry
*/
LazyActor.prototype.doAppear = function (entry) {
this.isAppear = true;
this.dispatch(AppearEvent.APPEAR, entry);
if (this.stage) {
this.stage.unobserve(this);
}
};
/**
* 스테이지 이탈.
* @override
* @param entry
*/
LazyActor.prototype.disappear = function (entry) {
this.clearAppearTimer();
if (!this.isAppear)
return;
this.isAppear = false;
this.dispatch(AppearEvent.DISAPPEAR, entry);
};
return LazyActor;
}(BaseActor));
/**
* Generated bundle index. Do not edit.
*/
exports.AppearEvent = AppearEvent;
exports.AppearStage = AppearStage;
exports.BaseActor = BaseActor;
exports.LazyActor = LazyActor;
exports.OnceActor = OnceActor;
Object.defineProperty(exports, '__esModule', { value: true });
}));
//# sourceMappingURL=jood-appearer.umd.js.map