@angular/cdk
Version:
Angular Material Component Development Kit
1,406 lines (1,400 loc) • 80.8 kB
JavaScript
import { coerceNumberProperty } from '@angular/cdk/coercion';
import { InjectionToken, Directive, forwardRef, Input, Injectable, NgZone, ɵɵdefineInjectable, ɵɵinject, ElementRef, Optional, Component, ViewEncapsulation, ChangeDetectionStrategy, ChangeDetectorRef, Inject, Output, ViewChild, ViewContainerRef, TemplateRef, IterableDiffers, SkipSelf, NgModule } from '@angular/core';
import { Subject, of, Observable, fromEvent, merge, animationFrameScheduler, asapScheduler, Subscription } from 'rxjs';
import { distinctUntilChanged, auditTime, filter, takeUntil, startWith, pairwise, switchMap, shareReplay } from 'rxjs/operators';
import { Platform, getRtlScrollAxisType, RtlScrollAxisType, supportsScrollBehavior, PlatformModule } from '@angular/cdk/platform';
import { Directionality, BidiModule } from '@angular/cdk/bidi';
import { isDataSource, ArrayDataSource } from '@angular/cdk/collections';
/**
* @fileoverview added by tsickle
* Generated from: src/cdk/scrolling/virtual-scroll-strategy.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* The injection token used to specify the virtual scrolling strategy.
* @type {?}
*/
const VIRTUAL_SCROLL_STRATEGY = new InjectionToken('VIRTUAL_SCROLL_STRATEGY');
/**
* A strategy that dictates which items should be rendered in the viewport.
* @record
*/
function VirtualScrollStrategy() { }
if (false) {
/**
* Emits when the index of the first element visible in the viewport changes.
* @type {?}
*/
VirtualScrollStrategy.prototype.scrolledIndexChange;
/**
* Attaches this scroll strategy to a viewport.
* @param {?} viewport The viewport to attach this strategy to.
* @return {?}
*/
VirtualScrollStrategy.prototype.attach = function (viewport) { };
/**
* Detaches this scroll strategy from the currently attached viewport.
* @return {?}
*/
VirtualScrollStrategy.prototype.detach = function () { };
/**
* Called when the viewport is scrolled (debounced using requestAnimationFrame).
* @return {?}
*/
VirtualScrollStrategy.prototype.onContentScrolled = function () { };
/**
* Called when the length of the data changes.
* @return {?}
*/
VirtualScrollStrategy.prototype.onDataLengthChanged = function () { };
/**
* Called when the range of items rendered in the DOM has changed.
* @return {?}
*/
VirtualScrollStrategy.prototype.onContentRendered = function () { };
/**
* Called when the offset of the rendered items changed.
* @return {?}
*/
VirtualScrollStrategy.prototype.onRenderedOffsetChanged = function () { };
/**
* Scroll to the offset for the given index.
* @param {?} index The index of the element to scroll to.
* @param {?} behavior The ScrollBehavior to use when scrolling.
* @return {?}
*/
VirtualScrollStrategy.prototype.scrollToIndex = function (index, behavior) { };
}
/**
* @fileoverview added by tsickle
* Generated from: src/cdk/scrolling/fixed-size-virtual-scroll.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Virtual scrolling strategy for lists with items of known fixed size.
*/
class FixedSizeVirtualScrollStrategy {
/**
* @param {?} itemSize The size of the items in the virtually scrolling list.
* @param {?} minBufferPx The minimum amount of buffer (in pixels) before needing to render more
* @param {?} maxBufferPx The amount of buffer (in pixels) to render when rendering more.
*/
constructor(itemSize, minBufferPx, maxBufferPx) {
this._scrolledIndexChange = new Subject();
/**
* \@docs-private Implemented as part of VirtualScrollStrategy.
*/
this.scrolledIndexChange = this._scrolledIndexChange.pipe(distinctUntilChanged());
/**
* The attached viewport.
*/
this._viewport = null;
this._itemSize = itemSize;
this._minBufferPx = minBufferPx;
this._maxBufferPx = maxBufferPx;
}
/**
* Attaches this scroll strategy to a viewport.
* @param {?} viewport The viewport to attach this strategy to.
* @return {?}
*/
attach(viewport) {
this._viewport = viewport;
this._updateTotalContentSize();
this._updateRenderedRange();
}
/**
* Detaches this scroll strategy from the currently attached viewport.
* @return {?}
*/
detach() {
this._scrolledIndexChange.complete();
this._viewport = null;
}
/**
* Update the item size and buffer size.
* @param {?} itemSize The size of the items in the virtually scrolling list.
* @param {?} minBufferPx The minimum amount of buffer (in pixels) before needing to render more
* @param {?} maxBufferPx The amount of buffer (in pixels) to render when rendering more.
* @return {?}
*/
updateItemAndBufferSize(itemSize, minBufferPx, maxBufferPx) {
if (maxBufferPx < minBufferPx) {
throw Error('CDK virtual scroll: maxBufferPx must be greater than or equal to minBufferPx');
}
this._itemSize = itemSize;
this._minBufferPx = minBufferPx;
this._maxBufferPx = maxBufferPx;
this._updateTotalContentSize();
this._updateRenderedRange();
}
/**
* \@docs-private Implemented as part of VirtualScrollStrategy.
* @return {?}
*/
onContentScrolled() {
this._updateRenderedRange();
}
/**
* \@docs-private Implemented as part of VirtualScrollStrategy.
* @return {?}
*/
onDataLengthChanged() {
this._updateTotalContentSize();
this._updateRenderedRange();
}
/**
* \@docs-private Implemented as part of VirtualScrollStrategy.
* @return {?}
*/
onContentRendered() { }
/**
* \@docs-private Implemented as part of VirtualScrollStrategy.
* @return {?}
*/
onRenderedOffsetChanged() { }
/**
* Scroll to the offset for the given index.
* @param {?} index The index of the element to scroll to.
* @param {?} behavior The ScrollBehavior to use when scrolling.
* @return {?}
*/
scrollToIndex(index, behavior) {
if (this._viewport) {
this._viewport.scrollToOffset(index * this._itemSize, behavior);
}
}
/**
* Update the viewport's total content size.
* @private
* @return {?}
*/
_updateTotalContentSize() {
if (!this._viewport) {
return;
}
this._viewport.setTotalContentSize(this._viewport.getDataLength() * this._itemSize);
}
/**
* Update the viewport's rendered range.
* @private
* @return {?}
*/
_updateRenderedRange() {
if (!this._viewport) {
return;
}
/** @type {?} */
const scrollOffset = this._viewport.measureScrollOffset();
/** @type {?} */
const firstVisibleIndex = scrollOffset / this._itemSize;
/** @type {?} */
const renderedRange = this._viewport.getRenderedRange();
/** @type {?} */
const newRange = { start: renderedRange.start, end: renderedRange.end };
/** @type {?} */
const viewportSize = this._viewport.getViewportSize();
/** @type {?} */
const dataLength = this._viewport.getDataLength();
/** @type {?} */
const startBuffer = scrollOffset - newRange.start * this._itemSize;
if (startBuffer < this._minBufferPx && newRange.start != 0) {
/** @type {?} */
const expandStart = Math.ceil((this._maxBufferPx - startBuffer) / this._itemSize);
newRange.start = Math.max(0, newRange.start - expandStart);
newRange.end = Math.min(dataLength, Math.ceil(firstVisibleIndex + (viewportSize + this._minBufferPx) / this._itemSize));
}
else {
/** @type {?} */
const endBuffer = newRange.end * this._itemSize - (scrollOffset + viewportSize);
if (endBuffer < this._minBufferPx && newRange.end != dataLength) {
/** @type {?} */
const expandEnd = Math.ceil((this._maxBufferPx - endBuffer) / this._itemSize);
if (expandEnd > 0) {
newRange.end = Math.min(dataLength, newRange.end + expandEnd);
newRange.start = Math.max(0, Math.floor(firstVisibleIndex - this._minBufferPx / this._itemSize));
}
}
}
this._viewport.setRenderedRange(newRange);
this._viewport.setRenderedContentOffset(this._itemSize * newRange.start);
this._scrolledIndexChange.next(Math.floor(firstVisibleIndex));
}
}
if (false) {
/**
* @type {?}
* @private
*/
FixedSizeVirtualScrollStrategy.prototype._scrolledIndexChange;
/**
* \@docs-private Implemented as part of VirtualScrollStrategy.
* @type {?}
*/
FixedSizeVirtualScrollStrategy.prototype.scrolledIndexChange;
/**
* The attached viewport.
* @type {?}
* @private
*/
FixedSizeVirtualScrollStrategy.prototype._viewport;
/**
* The size of the items in the virtually scrolling list.
* @type {?}
* @private
*/
FixedSizeVirtualScrollStrategy.prototype._itemSize;
/**
* The minimum amount of buffer rendered beyond the viewport (in pixels).
* @type {?}
* @private
*/
FixedSizeVirtualScrollStrategy.prototype._minBufferPx;
/**
* The number of buffer items to render beyond the edge of the viewport (in pixels).
* @type {?}
* @private
*/
FixedSizeVirtualScrollStrategy.prototype._maxBufferPx;
}
/**
* Provider factory for `FixedSizeVirtualScrollStrategy` that simply extracts the already created
* `FixedSizeVirtualScrollStrategy` from the given directive.
* @param {?} fixedSizeDir The instance of `CdkFixedSizeVirtualScroll` to extract the
* `FixedSizeVirtualScrollStrategy` from.
* @return {?}
*/
function _fixedSizeVirtualScrollStrategyFactory(fixedSizeDir) {
return fixedSizeDir._scrollStrategy;
}
/**
* A virtual scroll strategy that supports fixed-size items.
*/
class CdkFixedSizeVirtualScroll {
constructor() {
this._itemSize = 20;
this._minBufferPx = 100;
this._maxBufferPx = 200;
/**
* The scroll strategy used by this directive.
*/
this._scrollStrategy = new FixedSizeVirtualScrollStrategy(this.itemSize, this.minBufferPx, this.maxBufferPx);
}
/**
* The size of the items in the list (in pixels).
* @return {?}
*/
get itemSize() { return this._itemSize; }
/**
* @param {?} value
* @return {?}
*/
set itemSize(value) { this._itemSize = coerceNumberProperty(value); }
/**
* The minimum amount of buffer rendered beyond the viewport (in pixels).
* If the amount of buffer dips below this number, more items will be rendered. Defaults to 100px.
* @return {?}
*/
get minBufferPx() { return this._minBufferPx; }
/**
* @param {?} value
* @return {?}
*/
set minBufferPx(value) { this._minBufferPx = coerceNumberProperty(value); }
/**
* The number of pixels worth of buffer to render for when rendering new items. Defaults to 200px.
* @return {?}
*/
get maxBufferPx() { return this._maxBufferPx; }
/**
* @param {?} value
* @return {?}
*/
set maxBufferPx(value) { this._maxBufferPx = coerceNumberProperty(value); }
/**
* @return {?}
*/
ngOnChanges() {
this._scrollStrategy.updateItemAndBufferSize(this.itemSize, this.minBufferPx, this.maxBufferPx);
}
}
CdkFixedSizeVirtualScroll.decorators = [
{ type: Directive, args: [{
selector: 'cdk-virtual-scroll-viewport[itemSize]',
providers: [{
provide: VIRTUAL_SCROLL_STRATEGY,
useFactory: _fixedSizeVirtualScrollStrategyFactory,
deps: [forwardRef((/**
* @return {?}
*/
() => CdkFixedSizeVirtualScroll))],
}],
},] }
];
CdkFixedSizeVirtualScroll.propDecorators = {
itemSize: [{ type: Input }],
minBufferPx: [{ type: Input }],
maxBufferPx: [{ type: Input }]
};
if (false) {
/** @type {?} */
CdkFixedSizeVirtualScroll.ngAcceptInputType_itemSize;
/** @type {?} */
CdkFixedSizeVirtualScroll.ngAcceptInputType_minBufferPx;
/** @type {?} */
CdkFixedSizeVirtualScroll.ngAcceptInputType_maxBufferPx;
/** @type {?} */
CdkFixedSizeVirtualScroll.prototype._itemSize;
/** @type {?} */
CdkFixedSizeVirtualScroll.prototype._minBufferPx;
/** @type {?} */
CdkFixedSizeVirtualScroll.prototype._maxBufferPx;
/**
* The scroll strategy used by this directive.
* @type {?}
*/
CdkFixedSizeVirtualScroll.prototype._scrollStrategy;
}
/**
* @fileoverview added by tsickle
* Generated from: src/cdk/scrolling/scroll-dispatcher.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Time in ms to throttle the scrolling events by default.
* @type {?}
*/
const DEFAULT_SCROLL_TIME = 20;
/**
* Service contained all registered Scrollable references and emits an event when any one of the
* Scrollable references emit a scrolled event.
*/
class ScrollDispatcher {
/**
* @param {?} _ngZone
* @param {?} _platform
*/
constructor(_ngZone, _platform) {
this._ngZone = _ngZone;
this._platform = _platform;
/**
* Subject for notifying that a registered scrollable reference element has been scrolled.
*/
this._scrolled = new Subject();
/**
* Keeps track of the global `scroll` and `resize` subscriptions.
*/
this._globalSubscription = null;
/**
* Keeps track of the amount of subscriptions to `scrolled`. Used for cleaning up afterwards.
*/
this._scrolledCount = 0;
/**
* Map of all the scrollable references that are registered with the service and their
* scroll event subscriptions.
*/
this.scrollContainers = new Map();
}
/**
* Registers a scrollable instance with the service and listens for its scrolled events. When the
* scrollable is scrolled, the service emits the event to its scrolled observable.
* @param {?} scrollable Scrollable instance to be registered.
* @return {?}
*/
register(scrollable) {
if (!this.scrollContainers.has(scrollable)) {
this.scrollContainers.set(scrollable, scrollable.elementScrolled()
.subscribe((/**
* @return {?}
*/
() => this._scrolled.next(scrollable))));
}
}
/**
* Deregisters a Scrollable reference and unsubscribes from its scroll event observable.
* @param {?} scrollable Scrollable instance to be deregistered.
* @return {?}
*/
deregister(scrollable) {
/** @type {?} */
const scrollableReference = this.scrollContainers.get(scrollable);
if (scrollableReference) {
scrollableReference.unsubscribe();
this.scrollContainers.delete(scrollable);
}
}
/**
* Returns an observable that emits an event whenever any of the registered Scrollable
* references (or window, document, or body) fire a scrolled event. Can provide a time in ms
* to override the default "throttle" time.
*
* **Note:** in order to avoid hitting change detection for every scroll event,
* all of the events emitted from this stream will be run outside the Angular zone.
* If you need to update any data bindings as a result of a scroll event, you have
* to run the callback using `NgZone.run`.
* @param {?=} auditTimeInMs
* @return {?}
*/
scrolled(auditTimeInMs = DEFAULT_SCROLL_TIME) {
if (!this._platform.isBrowser) {
return of();
}
return new Observable((/**
* @param {?} observer
* @return {?}
*/
(observer) => {
if (!this._globalSubscription) {
this._addGlobalListener();
}
// In the case of a 0ms delay, use an observable without auditTime
// since it does add a perceptible delay in processing overhead.
/** @type {?} */
const subscription = auditTimeInMs > 0 ?
this._scrolled.pipe(auditTime(auditTimeInMs)).subscribe(observer) :
this._scrolled.subscribe(observer);
this._scrolledCount++;
return (/**
* @return {?}
*/
() => {
subscription.unsubscribe();
this._scrolledCount--;
if (!this._scrolledCount) {
this._removeGlobalListener();
}
});
}));
}
/**
* @return {?}
*/
ngOnDestroy() {
this._removeGlobalListener();
this.scrollContainers.forEach((/**
* @param {?} _
* @param {?} container
* @return {?}
*/
(_, container) => this.deregister(container)));
this._scrolled.complete();
}
/**
* Returns an observable that emits whenever any of the
* scrollable ancestors of an element are scrolled.
* @param {?} elementRef Element whose ancestors to listen for.
* @param {?=} auditTimeInMs Time to throttle the scroll events.
* @return {?}
*/
ancestorScrolled(elementRef, auditTimeInMs) {
/** @type {?} */
const ancestors = this.getAncestorScrollContainers(elementRef);
return this.scrolled(auditTimeInMs).pipe(filter((/**
* @param {?} target
* @return {?}
*/
target => {
return !target || ancestors.indexOf(target) > -1;
})));
}
/**
* Returns all registered Scrollables that contain the provided element.
* @param {?} elementRef
* @return {?}
*/
getAncestorScrollContainers(elementRef) {
/** @type {?} */
const scrollingContainers = [];
this.scrollContainers.forEach((/**
* @param {?} _subscription
* @param {?} scrollable
* @return {?}
*/
(_subscription, scrollable) => {
if (this._scrollableContainsElement(scrollable, elementRef)) {
scrollingContainers.push(scrollable);
}
}));
return scrollingContainers;
}
/**
* Returns true if the element is contained within the provided Scrollable.
* @private
* @param {?} scrollable
* @param {?} elementRef
* @return {?}
*/
_scrollableContainsElement(scrollable, elementRef) {
/** @type {?} */
let element = elementRef.nativeElement;
/** @type {?} */
let scrollableElement = scrollable.getElementRef().nativeElement;
// Traverse through the element parents until we reach null, checking if any of the elements
// are the scrollable's element.
do {
if (element == scrollableElement) {
return true;
}
} while (element = (/** @type {?} */ (element)).parentElement);
return false;
}
/**
* Sets up the global scroll listeners.
* @private
* @return {?}
*/
_addGlobalListener() {
this._globalSubscription = this._ngZone.runOutsideAngular((/**
* @return {?}
*/
() => {
return fromEvent(window.document, 'scroll').subscribe((/**
* @return {?}
*/
() => this._scrolled.next()));
}));
}
/**
* Cleans up the global scroll listener.
* @private
* @return {?}
*/
_removeGlobalListener() {
if (this._globalSubscription) {
this._globalSubscription.unsubscribe();
this._globalSubscription = null;
}
}
}
ScrollDispatcher.decorators = [
{ type: Injectable, args: [{ providedIn: 'root' },] }
];
/** @nocollapse */
ScrollDispatcher.ctorParameters = () => [
{ type: NgZone },
{ type: Platform }
];
/** @nocollapse */ ScrollDispatcher.ɵprov = ɵɵdefineInjectable({ factory: function ScrollDispatcher_Factory() { return new ScrollDispatcher(ɵɵinject(NgZone), ɵɵinject(Platform)); }, token: ScrollDispatcher, providedIn: "root" });
if (false) {
/**
* Subject for notifying that a registered scrollable reference element has been scrolled.
* @type {?}
* @private
*/
ScrollDispatcher.prototype._scrolled;
/**
* Keeps track of the global `scroll` and `resize` subscriptions.
* @type {?}
*/
ScrollDispatcher.prototype._globalSubscription;
/**
* Keeps track of the amount of subscriptions to `scrolled`. Used for cleaning up afterwards.
* @type {?}
* @private
*/
ScrollDispatcher.prototype._scrolledCount;
/**
* Map of all the scrollable references that are registered with the service and their
* scroll event subscriptions.
* @type {?}
*/
ScrollDispatcher.prototype.scrollContainers;
/**
* @type {?}
* @private
*/
ScrollDispatcher.prototype._ngZone;
/**
* @type {?}
* @private
*/
ScrollDispatcher.prototype._platform;
}
/**
* @fileoverview added by tsickle
* Generated from: src/cdk/scrolling/scrollable.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Sends an event when the directive's element is scrolled. Registers itself with the
* ScrollDispatcher service to include itself as part of its collection of scrolling events that it
* can be listened to through the service.
*/
class CdkScrollable {
/**
* @param {?} elementRef
* @param {?} scrollDispatcher
* @param {?} ngZone
* @param {?=} dir
*/
constructor(elementRef, scrollDispatcher, ngZone, dir) {
this.elementRef = elementRef;
this.scrollDispatcher = scrollDispatcher;
this.ngZone = ngZone;
this.dir = dir;
this._destroyed = new Subject();
this._elementScrolled = new Observable((/**
* @param {?} observer
* @return {?}
*/
(observer) => this.ngZone.runOutsideAngular((/**
* @return {?}
*/
() => fromEvent(this.elementRef.nativeElement, 'scroll').pipe(takeUntil(this._destroyed))
.subscribe(observer)))));
}
/**
* @return {?}
*/
ngOnInit() {
this.scrollDispatcher.register(this);
}
/**
* @return {?}
*/
ngOnDestroy() {
this.scrollDispatcher.deregister(this);
this._destroyed.next();
this._destroyed.complete();
}
/**
* Returns observable that emits when a scroll event is fired on the host element.
* @return {?}
*/
elementScrolled() {
return this._elementScrolled;
}
/**
* Gets the ElementRef for the viewport.
* @return {?}
*/
getElementRef() {
return this.elementRef;
}
/**
* Scrolls to the specified offsets. This is a normalized version of the browser's native scrollTo
* method, since browsers are not consistent about what scrollLeft means in RTL. For this method
* left and right always refer to the left and right side of the scrolling container irrespective
* of the layout direction. start and end refer to left and right in an LTR context and vice-versa
* in an RTL context.
* @param {?} options specified the offsets to scroll to.
* @return {?}
*/
scrollTo(options) {
/** @type {?} */
const el = this.elementRef.nativeElement;
/** @type {?} */
const isRtl = this.dir && this.dir.value == 'rtl';
// Rewrite start & end offsets as right or left offsets.
options.left = options.left == null ? (isRtl ? options.end : options.start) : options.left;
options.right = options.right == null ? (isRtl ? options.start : options.end) : options.right;
// Rewrite the bottom offset as a top offset.
if (options.bottom != null) {
((/** @type {?} */ (options))).top =
el.scrollHeight - el.clientHeight - options.bottom;
}
// Rewrite the right offset as a left offset.
if (isRtl && getRtlScrollAxisType() != RtlScrollAxisType.NORMAL) {
if (options.left != null) {
((/** @type {?} */ (options))).right =
el.scrollWidth - el.clientWidth - options.left;
}
if (getRtlScrollAxisType() == RtlScrollAxisType.INVERTED) {
options.left = options.right;
}
else if (getRtlScrollAxisType() == RtlScrollAxisType.NEGATED) {
options.left = options.right ? -options.right : options.right;
}
}
else {
if (options.right != null) {
((/** @type {?} */ (options))).left =
el.scrollWidth - el.clientWidth - options.right;
}
}
this._applyScrollToOptions(options);
}
/**
* @private
* @param {?} options
* @return {?}
*/
_applyScrollToOptions(options) {
/** @type {?} */
const el = this.elementRef.nativeElement;
if (supportsScrollBehavior()) {
el.scrollTo(options);
}
else {
if (options.top != null) {
el.scrollTop = options.top;
}
if (options.left != null) {
el.scrollLeft = options.left;
}
}
}
/**
* Measures the scroll offset relative to the specified edge of the viewport. This method can be
* used instead of directly checking scrollLeft or scrollTop, since browsers are not consistent
* about what scrollLeft means in RTL. The values returned by this method are normalized such that
* left and right always refer to the left and right side of the scrolling container irrespective
* of the layout direction. start and end refer to left and right in an LTR context and vice-versa
* in an RTL context.
* @param {?} from The edge to measure from.
* @return {?}
*/
measureScrollOffset(from) {
/** @type {?} */
const LEFT = 'left';
/** @type {?} */
const RIGHT = 'right';
/** @type {?} */
const el = this.elementRef.nativeElement;
if (from == 'top') {
return el.scrollTop;
}
if (from == 'bottom') {
return el.scrollHeight - el.clientHeight - el.scrollTop;
}
// Rewrite start & end as left or right offsets.
/** @type {?} */
const isRtl = this.dir && this.dir.value == 'rtl';
if (from == 'start') {
from = isRtl ? RIGHT : LEFT;
}
else if (from == 'end') {
from = isRtl ? LEFT : RIGHT;
}
if (isRtl && getRtlScrollAxisType() == RtlScrollAxisType.INVERTED) {
// For INVERTED, scrollLeft is (scrollWidth - clientWidth) when scrolled all the way left and
// 0 when scrolled all the way right.
if (from == LEFT) {
return el.scrollWidth - el.clientWidth - el.scrollLeft;
}
else {
return el.scrollLeft;
}
}
else if (isRtl && getRtlScrollAxisType() == RtlScrollAxisType.NEGATED) {
// For NEGATED, scrollLeft is -(scrollWidth - clientWidth) when scrolled all the way left and
// 0 when scrolled all the way right.
if (from == LEFT) {
return el.scrollLeft + el.scrollWidth - el.clientWidth;
}
else {
return -el.scrollLeft;
}
}
else {
// For NORMAL, as well as non-RTL contexts, scrollLeft is 0 when scrolled all the way left and
// (scrollWidth - clientWidth) when scrolled all the way right.
if (from == LEFT) {
return el.scrollLeft;
}
else {
return el.scrollWidth - el.clientWidth - el.scrollLeft;
}
}
}
}
CdkScrollable.decorators = [
{ type: Directive, args: [{
selector: '[cdk-scrollable], [cdkScrollable]'
},] }
];
/** @nocollapse */
CdkScrollable.ctorParameters = () => [
{ type: ElementRef },
{ type: ScrollDispatcher },
{ type: NgZone },
{ type: Directionality, decorators: [{ type: Optional }] }
];
if (false) {
/**
* @type {?}
* @private
*/
CdkScrollable.prototype._destroyed;
/**
* @type {?}
* @private
*/
CdkScrollable.prototype._elementScrolled;
/**
* @type {?}
* @protected
*/
CdkScrollable.prototype.elementRef;
/**
* @type {?}
* @protected
*/
CdkScrollable.prototype.scrollDispatcher;
/**
* @type {?}
* @protected
*/
CdkScrollable.prototype.ngZone;
/**
* @type {?}
* @protected
*/
CdkScrollable.prototype.dir;
}
/**
* @fileoverview added by tsickle
* Generated from: src/cdk/scrolling/viewport-ruler.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Time in ms to throttle the resize events by default.
* @type {?}
*/
const DEFAULT_RESIZE_TIME = 20;
/**
* Object that holds the scroll position of the viewport in each direction.
* @record
*/
function ViewportScrollPosition() { }
if (false) {
/** @type {?} */
ViewportScrollPosition.prototype.top;
/** @type {?} */
ViewportScrollPosition.prototype.left;
}
/**
* Simple utility for getting the bounds of the browser viewport.
* \@docs-private
*/
class ViewportRuler {
/**
* @param {?} _platform
* @param {?} ngZone
*/
constructor(_platform, ngZone) {
this._platform = _platform;
ngZone.runOutsideAngular((/**
* @return {?}
*/
() => {
this._change = _platform.isBrowser ?
merge(fromEvent(window, 'resize'), fromEvent(window, 'orientationchange')) :
of();
// Note that we need to do the subscription inside `runOutsideAngular`
// since subscribing is what causes the event listener to be added.
this._invalidateCache = this.change().subscribe((/**
* @return {?}
*/
() => this._updateViewportSize()));
}));
}
/**
* @return {?}
*/
ngOnDestroy() {
this._invalidateCache.unsubscribe();
}
/**
* Returns the viewport's width and height.
* @return {?}
*/
getViewportSize() {
if (!this._viewportSize) {
this._updateViewportSize();
}
/** @type {?} */
const output = { width: this._viewportSize.width, height: this._viewportSize.height };
// If we're not on a browser, don't cache the size since it'll be mocked out anyway.
if (!this._platform.isBrowser) {
this._viewportSize = (/** @type {?} */ (null));
}
return output;
}
/**
* Gets a ClientRect for the viewport's bounds.
* @return {?}
*/
getViewportRect() {
// Use the document element's bounding rect rather than the window scroll properties
// (e.g. pageYOffset, scrollY) due to in issue in Chrome and IE where window scroll
// properties and client coordinates (boundingClientRect, clientX/Y, etc.) are in different
// conceptual viewports. Under most circumstances these viewports are equivalent, but they
// can disagree when the page is pinch-zoomed (on devices that support touch).
// See https://bugs.chromium.org/p/chromium/issues/detail?id=489206#c4
// We use the documentElement instead of the body because, by default (without a css reset)
// browsers typically give the document body an 8px margin, which is not included in
// getBoundingClientRect().
/** @type {?} */
const scrollPosition = this.getViewportScrollPosition();
const { width, height } = this.getViewportSize();
return {
top: scrollPosition.top,
left: scrollPosition.left,
bottom: scrollPosition.top + height,
right: scrollPosition.left + width,
height,
width,
};
}
/**
* Gets the (top, left) scroll position of the viewport.
* @return {?}
*/
getViewportScrollPosition() {
// While we can get a reference to the fake document
// during SSR, it doesn't have getBoundingClientRect.
if (!this._platform.isBrowser) {
return { top: 0, left: 0 };
}
// The top-left-corner of the viewport is determined by the scroll position of the document
// body, normally just (scrollLeft, scrollTop). However, Chrome and Firefox disagree about
// whether `document.body` or `document.documentElement` is the scrolled element, so reading
// `scrollTop` and `scrollLeft` is inconsistent. However, using the bounding rect of
// `document.documentElement` works consistently, where the `top` and `left` values will
// equal negative the scroll position.
/** @type {?} */
const documentElement = (/** @type {?} */ (document.documentElement));
/** @type {?} */
const documentRect = documentElement.getBoundingClientRect();
/** @type {?} */
const top = -documentRect.top || document.body.scrollTop || window.scrollY ||
documentElement.scrollTop || 0;
/** @type {?} */
const left = -documentRect.left || document.body.scrollLeft || window.scrollX ||
documentElement.scrollLeft || 0;
return { top, left };
}
/**
* Returns a stream that emits whenever the size of the viewport changes.
* @param {?=} throttleTime Time in milliseconds to throttle the stream.
* @return {?}
*/
change(throttleTime = DEFAULT_RESIZE_TIME) {
return throttleTime > 0 ? this._change.pipe(auditTime(throttleTime)) : this._change;
}
/**
* Updates the cached viewport size.
* @private
* @return {?}
*/
_updateViewportSize() {
this._viewportSize = this._platform.isBrowser ?
{ width: window.innerWidth, height: window.innerHeight } :
{ width: 0, height: 0 };
}
}
ViewportRuler.decorators = [
{ type: Injectable, args: [{ providedIn: 'root' },] }
];
/** @nocollapse */
ViewportRuler.ctorParameters = () => [
{ type: Platform },
{ type: NgZone }
];
/** @nocollapse */ ViewportRuler.ɵprov = ɵɵdefineInjectable({ factory: function ViewportRuler_Factory() { return new ViewportRuler(ɵɵinject(Platform), ɵɵinject(NgZone)); }, token: ViewportRuler, providedIn: "root" });
if (false) {
/**
* Cached viewport dimensions.
* @type {?}
* @private
*/
ViewportRuler.prototype._viewportSize;
/**
* Stream of viewport change events.
* @type {?}
* @private
*/
ViewportRuler.prototype._change;
/**
* Subscription to streams that invalidate the cached viewport dimensions.
* @type {?}
* @private
*/
ViewportRuler.prototype._invalidateCache;
/**
* @type {?}
* @private
*/
ViewportRuler.prototype._platform;
}
/**
* @fileoverview added by tsickle
* Generated from: src/cdk/scrolling/virtual-scroll-viewport.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Checks if the given ranges are equal.
* @param {?} r1
* @param {?} r2
* @return {?}
*/
function rangesEqual(r1, r2) {
return r1.start == r2.start && r1.end == r2.end;
}
/**
* Scheduler to be used for scroll events. Needs to fall back to
* something that doesn't rely on requestAnimationFrame on environments
* that don't support it (e.g. server-side rendering).
* @type {?}
*/
const SCROLL_SCHEDULER = typeof requestAnimationFrame !== 'undefined' ? animationFrameScheduler : asapScheduler;
/**
* A viewport that virtualizes its scrolling with the help of `CdkVirtualForOf`.
*/
class CdkVirtualScrollViewport extends CdkScrollable {
/**
* @param {?} elementRef
* @param {?} _changeDetectorRef
* @param {?} ngZone
* @param {?} _scrollStrategy
* @param {?} dir
* @param {?} scrollDispatcher
* @param {?=} viewportRuler
*/
constructor(elementRef, _changeDetectorRef, ngZone, _scrollStrategy, dir, scrollDispatcher,
/**
* @deprecated `viewportRuler` parameter to become required.
* @breaking-change 11.0.0
*/
viewportRuler) {
super(elementRef, scrollDispatcher, ngZone, dir);
this.elementRef = elementRef;
this._changeDetectorRef = _changeDetectorRef;
this._scrollStrategy = _scrollStrategy;
/**
* Emits when the viewport is detached from a CdkVirtualForOf.
*/
this._detachedSubject = new Subject();
/**
* Emits when the rendered range changes.
*/
this._renderedRangeSubject = new Subject();
this._orientation = 'vertical';
// Note: we don't use the typical EventEmitter here because we need to subscribe to the scroll
// strategy lazily (i.e. only if the user is actually listening to the events). We do this because
// depending on how the strategy calculates the scrolled index, it may come at a cost to
// performance.
/**
* Emits when the index of the first element visible in the viewport changes.
*/
this.scrolledIndexChange = new Observable((/**
* @param {?} observer
* @return {?}
*/
(observer) => this._scrollStrategy.scrolledIndexChange.subscribe((/**
* @param {?} index
* @return {?}
*/
index => Promise.resolve().then((/**
* @return {?}
*/
() => this.ngZone.run((/**
* @return {?}
*/
() => observer.next(index)))))))));
/**
* A stream that emits whenever the rendered range changes.
*/
this.renderedRangeStream = this._renderedRangeSubject.asObservable();
/**
* The total size of all content (in pixels), including content that is not currently rendered.
*/
this._totalContentSize = 0;
/**
* A string representing the `style.width` property value to be used for the spacer element.
*/
this._totalContentWidth = '';
/**
* A string representing the `style.height` property value to be used for the spacer element.
*/
this._totalContentHeight = '';
/**
* The currently rendered range of indices.
*/
this._renderedRange = { start: 0, end: 0 };
/**
* The length of the data bound to this viewport (in number of items).
*/
this._dataLength = 0;
/**
* The size of the viewport (in pixels).
*/
this._viewportSize = 0;
/**
* The last rendered content offset that was set.
*/
this._renderedContentOffset = 0;
/**
* Whether the last rendered content offset was to the end of the content (and therefore needs to
* be rewritten as an offset to the start of the content).
*/
this._renderedContentOffsetNeedsRewrite = false;
/**
* Whether there is a pending change detection cycle.
*/
this._isChangeDetectionPending = false;
/**
* A list of functions to run after the next change detection cycle.
*/
this._runAfterChangeDetection = [];
/**
* Subscription to changes in the viewport size.
*/
this._viewportChanges = Subscription.EMPTY;
if (!_scrollStrategy) {
throw Error('Error: cdk-virtual-scroll-viewport requires the "itemSize" property to be set.');
}
// @breaking-change 11.0.0 Remove null check for `viewportRuler`.
if (viewportRuler) {
this._viewportChanges = viewportRuler.change().subscribe((/**
* @return {?}
*/
() => {
this.checkViewportSize();
}));
}
}
/**
* The direction the viewport scrolls.
* @return {?}
*/
get orientation() {
return this._orientation;
}
/**
* @param {?} orientation
* @return {?}
*/
set orientation(orientation) {
if (this._orientation !== orientation) {
this._orientation = orientation;
this._calculateSpacerSize();
}
}
/**
* @return {?}
*/
ngOnInit() {
super.ngOnInit();
// It's still too early to measure the viewport at this point. Deferring with a promise allows
// the Viewport to be rendered with the correct size before we measure. We run this outside the
// zone to avoid causing more change detection cycles. We handle the change detection loop
// ourselves instead.
this.ngZone.runOutsideAngular((/**
* @return {?}
*/
() => Promise.resolve().then((/**
* @return {?}
*/
() => {
this._measureViewportSize();
this._scrollStrategy.attach(this);
this.elementScrolled()
.pipe(
// Start off with a fake scroll event so we properly detect our initial position.
startWith((/** @type {?} */ (null))),
// Collect multiple events into one until the next animation frame. This way if
// there are multiple scroll events in the same frame we only need to recheck
// our layout once.
auditTime(0, SCROLL_SCHEDULER))
.subscribe((/**
* @return {?}
*/
() => this._scrollStrategy.onContentScrolled()));
this._markChangeDetectionNeeded();
}))));
}
/**
* @return {?}
*/
ngOnDestroy() {
this.detach();
this._scrollStrategy.detach();
// Complete all subjects
this._renderedRangeSubject.complete();
this._detachedSubject.complete();
this._viewportChanges.unsubscribe();
super.ngOnDestroy();
}
/**
* Attaches a `CdkVirtualForOf` to this viewport.
* @param {?} forOf
* @return {?}
*/
attach(forOf) {
if (this._forOf) {
throw Error('CdkVirtualScrollViewport is already attached.');
}
// Subscribe to the data stream of the CdkVirtualForOf to keep track of when the data length
// changes. Run outside the zone to avoid triggering change detection, since we're managing the
// change detection loop ourselves.
this.ngZone.runOutsideAngular((/**
* @return {?}
*/
() => {
this._forOf = forOf;
this._forOf.dataStream.pipe(takeUntil(this._detachedSubject)).subscribe((/**
* @param {?} data
* @return {?}
*/
data => {
/** @type {?} */
const newLength = data.length;
if (newLength !== this._dataLength) {
this._dataLength = newLength;
this._scrollStrategy.onDataLengthChanged();
}
this._doChangeDetection();
}));
}));
}
/**
* Detaches the current `CdkVirtualForOf`.
* @return {?}
*/
detach() {
this._forOf = null;
this._detachedSubject.next();
}
/**
* Gets the length of the data bound to this viewport (in number of items).
* @return {?}
*/
getDataLength() {
return this._dataLength;
}
/**
* Gets the size of the viewport (in pixels).
* @return {?}
*/
getViewportSize() {
return this._viewportSize;
}
// TODO(mmalerba): This is technically out of sync with what's really rendered until a render
// cycle happens. I'm being careful to only call it after the render cycle is complete and before
// setting it to something else, but its error prone and should probably be split into
// `pendingRange` and `renderedRange`, the latter reflecting whats actually in the DOM.
/**
* Get the current rendered range of items.
* @return {?}
*/
getRenderedRange() {
return this._renderedRange;
}
/**
* Sets the total size of all content (in pixels), including content that is not currently
* rendered.
* @param {?} size
* @return {?}
*/
setTotalContentSize(size) {
if (this._totalContentSize !== size) {
this._totalContentSize = size;
this._calculateSpacerSize();
this._markChangeDetectionNeeded();
}
}
/**
* Sets the currently rendered range of indices.
* @param {?} range
* @return {?}
*/
setRenderedRange(range) {
if (!rangesEqual(this._renderedRange, range)) {
this._renderedRangeSubject.next(this._renderedRange = range);
this._markChangeDetectionNeeded((/**
* @return {?}
*/
() => this._scrollStrategy.onContentRendered()));
}
}
/**
* Gets the offset from the start of the viewport to the start of the rendered data (in pixels).
* @return {?}
*/
getOffsetToRenderedContentStart() {
return this._renderedContentOffsetNeedsRewrite ? null : this._renderedContentOffset;
}
/**
* Sets the offset from the start of the viewport to either the start or end of the rendered data
* (in pixels).
* @param {?} offset
* @param {?=} to
* @return {?}
*/
setRenderedContentOffset(offset, to = 'to-start') {
// For a horizontal viewport in a right-to-left language we need to translate along the x-axis
// in the negative direction.
/** @type {?} */
const isRtl = this.dir && this.dir.value == 'rtl';
/** @type {?} */
const isHorizontal = this.orientation == 'horizontal';
/** @type {?} */
const axis = isHorizontal ? 'X' : 'Y';
/** @type {?} */
const axisDirection = isHorizontal && isRtl ? -1 : 1;
/** @type {?} */
let transform = `translate${axis}(${Number(axisDirection * offset)}px)`;
this._renderedContentOffset = offset;
if (to === 'to-end') {
transform += ` translate${axis}(-100%)`;
// The viewport should rewrite this as a `to-start` offset on the next render cycle. Otherwise
// elements will appear to expand in the wrong direction (e.g. `mat-expansion-panel` would
// expand upward).
this._renderedContentOffsetNeedsRewrite = true;
}
if (this._renderedContentTransform != transform) {
// We know this value is safe because we parse `offset` with `Number()` before passing it
// into the string.
this._renderedContentTransform = transform;
this._markChangeDetectionNeeded((/**
* @return {?}
*/
() => {
if (this._renderedContentOffsetNeedsRewrite) {
this._renderedContentOffset -= this.measureRenderedContentSize();
this._renderedContentOffsetNeedsRewrite = false;
this.setRenderedContentOffset(this._renderedContentOffset);
}
else {
this._scrollStrategy.onRenderedOffsetChanged();
}
}));
}
}
/**
* Scrolls to the given offset from the start of the viewport. Please note that this is not always
* the same as setting `scrollTop` or `scrollLeft`. In a horizontal viewport with right-to-left
* direction, this would be the equivalent of setting a fictional `scrollRight` property.
* @param {?} offset The offset to scroll to.
* @param {?=} behavior The ScrollBehavior to use when scrolling. Default is behavior is `auto`.
* @return {?}
*/
scrollToOffset(offset, behavior = 'auto') {
/** @type {?} */
const options = { behavior };
if (this.orientation === 'horizontal') {
options.start = offset;
}
else {
options.top = offset;
}
this.scrollTo(options);
}
/**
* Scrolls to the offset for the given index.
* @param {?} index The index of the element to scroll to.
* @param {?=} behavior The ScrollBehavior to use when scrolling. Default is behavior is `auto`.
* @return {?}
*/
scrollToIndex(index, behavior = 'auto') {
this._scrollStrategy.scrollToIndex(index, behavior);
}
/**
* Gets the current scroll offset from the start of the viewport (in pixels).
* @param {?=} from The edge to measure the offset from. Defaults to 'top' in vertical mode and 'start'
* in horizontal mode.
* @return {?}
*/
measureScrollOffse