@angular/material
Version:
Angular Material
465 lines (458 loc) • 18.4 kB
JavaScript
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import { Injectable, Optional, SkipSelf, NgModule, ChangeDetectionStrategy, ChangeDetectorRef, Component, EventEmitter, Input, Output, ViewEncapsulation, ɵɵdefineInjectable } from '@angular/core';
import { Subject } from 'rxjs';
import { coerceNumberProperty, coerceBooleanProperty } from '@angular/cdk/coercion';
import { mixinInitialized, mixinDisabled } from '@angular/material/core';
import { CommonModule } from '@angular/common';
import { MatButtonModule } from '@angular/material/button';
import { MatSelectModule } from '@angular/material/select';
import { MatTooltipModule } from '@angular/material/tooltip';
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* To modify the labels and text displayed, create a new instance of MatPaginatorIntl and
* include it in a custom provider
*/
class MatPaginatorIntl {
constructor() {
/**
* Stream to emit from when labels are changed. Use this to notify components when the labels have
* changed after initialization.
*/
this.changes = new Subject();
/**
* A label for the page size selector.
*/
this.itemsPerPageLabel = 'Items per page:';
/**
* A label for the button that increments the current page.
*/
this.nextPageLabel = 'Next page';
/**
* A label for the button that decrements the current page.
*/
this.previousPageLabel = 'Previous page';
/**
* A label for the button that moves to the first page.
*/
this.firstPageLabel = 'First page';
/**
* A label for the button that moves to the last page.
*/
this.lastPageLabel = 'Last page';
/**
* A label for the range of items within the current page and the length of the whole list.
*/
this.getRangeLabel = (/**
* @param {?} page
* @param {?} pageSize
* @param {?} length
* @return {?}
*/
(page, pageSize, length) => {
if (length == 0 || pageSize == 0) {
return `0 of ${length}`;
}
length = Math.max(length, 0);
/** @type {?} */
const startIndex = page * pageSize;
// If the start index exceeds the list length, do not try and fix the end index to the end.
/** @type {?} */
const endIndex = startIndex < length ?
Math.min(startIndex + pageSize, length) :
startIndex + pageSize;
return `${startIndex + 1} – ${endIndex} of ${length}`;
});
}
}
MatPaginatorIntl.decorators = [
{ type: Injectable, args: [{ providedIn: 'root' },] },
];
/** @nocollapse */ MatPaginatorIntl.ngInjectableDef = ɵɵdefineInjectable({ factory: function MatPaginatorIntl_Factory() { return new MatPaginatorIntl(); }, token: MatPaginatorIntl, providedIn: "root" });
/**
* \@docs-private
* @param {?} parentIntl
* @return {?}
*/
function MAT_PAGINATOR_INTL_PROVIDER_FACTORY(parentIntl) {
return parentIntl || new MatPaginatorIntl();
}
/**
* \@docs-private
* @type {?}
*/
const MAT_PAGINATOR_INTL_PROVIDER = {
// If there is already an MatPaginatorIntl available, use that. Otherwise, provide a new one.
provide: MatPaginatorIntl,
deps: [[new Optional(), new SkipSelf(), MatPaginatorIntl]],
useFactory: MAT_PAGINATOR_INTL_PROVIDER_FACTORY
};
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* The default page size if there is no page size and there are no provided page size options.
* @type {?}
*/
const DEFAULT_PAGE_SIZE = 50;
/**
* Change event object that is emitted when the user selects a
* different page size or navigates to another page.
*/
class PageEvent {
}
// Boilerplate for applying mixins to MatPaginator.
/**
* \@docs-private
*/
class MatPaginatorBase {
}
/** @type {?} */
const _MatPaginatorBase = mixinDisabled(mixinInitialized(MatPaginatorBase));
/**
* Component to provide navigation between paged information. Displays the size of the current
* page, user-selectable options to change that size, what items are being shown, and
* navigational button to go to the previous or next page.
*/
class MatPaginator extends _MatPaginatorBase {
/**
* @param {?} _intl
* @param {?} _changeDetectorRef
*/
constructor(_intl, _changeDetectorRef) {
super();
this._intl = _intl;
this._changeDetectorRef = _changeDetectorRef;
this._pageIndex = 0;
this._length = 0;
this._pageSizeOptions = [];
this._hidePageSize = false;
this._showFirstLastButtons = false;
/**
* Event emitted when the paginator changes the page size or page index.
*/
this.page = new EventEmitter();
this._intlChanges = _intl.changes.subscribe((/**
* @return {?}
*/
() => this._changeDetectorRef.markForCheck()));
}
/**
* The zero-based page index of the displayed list of items. Defaulted to 0.
* @return {?}
*/
get pageIndex() { return this._pageIndex; }
/**
* @param {?} value
* @return {?}
*/
set pageIndex(value) {
this._pageIndex = Math.max(coerceNumberProperty(value), 0);
this._changeDetectorRef.markForCheck();
}
/**
* The length of the total number of items that are being paginated. Defaulted to 0.
* @return {?}
*/
get length() { return this._length; }
/**
* @param {?} value
* @return {?}
*/
set length(value) {
this._length = coerceNumberProperty(value);
this._changeDetectorRef.markForCheck();
}
/**
* Number of items to display on a page. By default set to 50.
* @return {?}
*/
get pageSize() { return this._pageSize; }
/**
* @param {?} value
* @return {?}
*/
set pageSize(value) {
this._pageSize = Math.max(coerceNumberProperty(value), 0);
this._updateDisplayedPageSizeOptions();
}
/**
* The set of provided page size options to display to the user.
* @return {?}
*/
get pageSizeOptions() { return this._pageSizeOptions; }
/**
* @param {?} value
* @return {?}
*/
set pageSizeOptions(value) {
this._pageSizeOptions = (value || []).map((/**
* @param {?} p
* @return {?}
*/
p => coerceNumberProperty(p)));
this._updateDisplayedPageSizeOptions();
}
/**
* Whether to hide the page size selection UI from the user.
* @return {?}
*/
get hidePageSize() { return this._hidePageSize; }
/**
* @param {?} value
* @return {?}
*/
set hidePageSize(value) {
this._hidePageSize = coerceBooleanProperty(value);
}
/**
* Whether to show the first/last buttons UI to the user.
* @return {?}
*/
get showFirstLastButtons() { return this._showFirstLastButtons; }
/**
* @param {?} value
* @return {?}
*/
set showFirstLastButtons(value) {
this._showFirstLastButtons = coerceBooleanProperty(value);
}
/**
* @return {?}
*/
ngOnInit() {
this._initialized = true;
this._updateDisplayedPageSizeOptions();
this._markInitialized();
}
/**
* @return {?}
*/
ngOnDestroy() {
this._intlChanges.unsubscribe();
}
/**
* Advances to the next page if it exists.
* @return {?}
*/
nextPage() {
if (!this.hasNextPage()) {
return;
}
/** @type {?} */
const previousPageIndex = this.pageIndex;
this.pageIndex++;
this._emitPageEvent(previousPageIndex);
}
/**
* Move back to the previous page if it exists.
* @return {?}
*/
previousPage() {
if (!this.hasPreviousPage()) {
return;
}
/** @type {?} */
const previousPageIndex = this.pageIndex;
this.pageIndex--;
this._emitPageEvent(previousPageIndex);
}
/**
* Move to the first page if not already there.
* @return {?}
*/
firstPage() {
// hasPreviousPage being false implies at the start
if (!this.hasPreviousPage()) {
return;
}
/** @type {?} */
const previousPageIndex = this.pageIndex;
this.pageIndex = 0;
this._emitPageEvent(previousPageIndex);
}
/**
* Move to the last page if not already there.
* @return {?}
*/
lastPage() {
// hasNextPage being false implies at the end
if (!this.hasNextPage()) {
return;
}
/** @type {?} */
const previousPageIndex = this.pageIndex;
this.pageIndex = this.getNumberOfPages() - 1;
this._emitPageEvent(previousPageIndex);
}
/**
* Whether there is a previous page.
* @return {?}
*/
hasPreviousPage() {
return this.pageIndex >= 1 && this.pageSize != 0;
}
/**
* Whether there is a next page.
* @return {?}
*/
hasNextPage() {
/** @type {?} */
const maxPageIndex = this.getNumberOfPages() - 1;
return this.pageIndex < maxPageIndex && this.pageSize != 0;
}
/**
* Calculate the number of pages
* @return {?}
*/
getNumberOfPages() {
if (!this.pageSize) {
return 0;
}
return Math.ceil(this.length / this.pageSize);
}
/**
* Changes the page size so that the first item displayed on the page will still be
* displayed using the new page size.
*
* For example, if the page size is 10 and on the second page (items indexed 10-19) then
* switching so that the page size is 5 will set the third page as the current page so
* that the 10th item will still be displayed.
* @param {?} pageSize
* @return {?}
*/
_changePageSize(pageSize) {
// Current page needs to be updated to reflect the new page size. Navigate to the page
// containing the previous page's first item.
/** @type {?} */
const startIndex = this.pageIndex * this.pageSize;
/** @type {?} */
const previousPageIndex = this.pageIndex;
this.pageIndex = Math.floor(startIndex / pageSize) || 0;
this.pageSize = pageSize;
this._emitPageEvent(previousPageIndex);
}
/**
* Checks whether the buttons for going forwards should be disabled.
* @return {?}
*/
_nextButtonsDisabled() {
return this.disabled || !this.hasNextPage();
}
/**
* Checks whether the buttons for going backwards should be disabled.
* @return {?}
*/
_previousButtonsDisabled() {
return this.disabled || !this.hasPreviousPage();
}
/**
* Updates the list of page size options to display to the user. Includes making sure that
* the page size is an option and that the list is sorted.
* @private
* @return {?}
*/
_updateDisplayedPageSizeOptions() {
if (!this._initialized) {
return;
}
// If no page size is provided, use the first page size option or the default page size.
if (!this.pageSize) {
this._pageSize = this.pageSizeOptions.length != 0 ?
this.pageSizeOptions[0] :
DEFAULT_PAGE_SIZE;
}
this._displayedPageSizeOptions = this.pageSizeOptions.slice();
if (this._displayedPageSizeOptions.indexOf(this.pageSize) === -1) {
this._displayedPageSizeOptions.push(this.pageSize);
}
// Sort the numbers using a number-specific sort function.
this._displayedPageSizeOptions.sort((/**
* @param {?} a
* @param {?} b
* @return {?}
*/
(a, b) => a - b));
this._changeDetectorRef.markForCheck();
}
/**
* Emits an event notifying that a change of the paginator's properties has been triggered.
* @private
* @param {?} previousPageIndex
* @return {?}
*/
_emitPageEvent(previousPageIndex) {
this.page.emit({
previousPageIndex,
pageIndex: this.pageIndex,
pageSize: this.pageSize,
length: this.length
});
}
}
MatPaginator.decorators = [
{ type: Component, args: [{selector: 'mat-paginator',
exportAs: 'matPaginator',
template: "<div class=\"mat-paginator-outer-container\"><div class=\"mat-paginator-container\"><div class=\"mat-paginator-page-size\" *ngIf=\"!hidePageSize\"><div class=\"mat-paginator-page-size-label\">{{_intl.itemsPerPageLabel}}</div><mat-form-field *ngIf=\"_displayedPageSizeOptions.length > 1\" [color]=\"color\" class=\"mat-paginator-page-size-select\"><mat-select [value]=\"pageSize\" [disabled]=\"disabled\" [aria-label]=\"_intl.itemsPerPageLabel\" (selectionChange)=\"_changePageSize($event.value)\"><mat-option *ngFor=\"let pageSizeOption of _displayedPageSizeOptions\" [value]=\"pageSizeOption\">{{pageSizeOption}}</mat-option></mat-select></mat-form-field><div *ngIf=\"_displayedPageSizeOptions.length <= 1\">{{pageSize}}</div></div><div class=\"mat-paginator-range-actions\"><div class=\"mat-paginator-range-label\">{{_intl.getRangeLabel(pageIndex, pageSize, length)}}</div><button mat-icon-button type=\"button\" class=\"mat-paginator-navigation-first\" (click)=\"firstPage()\" [attr.aria-label]=\"_intl.firstPageLabel\" [matTooltip]=\"_intl.firstPageLabel\" [matTooltipDisabled]=\"_previousButtonsDisabled()\" [matTooltipPosition]=\"'above'\" [disabled]=\"_previousButtonsDisabled()\" *ngIf=\"showFirstLastButtons\"><svg class=\"mat-paginator-icon\" viewBox=\"0 0 24 24\" focusable=\"false\"><path d=\"M18.41 16.59L13.82 12l4.59-4.59L17 6l-6 6 6 6zM6 6h2v12H6z\"/></svg></button> <button mat-icon-button type=\"button\" class=\"mat-paginator-navigation-previous\" (click)=\"previousPage()\" [attr.aria-label]=\"_intl.previousPageLabel\" [matTooltip]=\"_intl.previousPageLabel\" [matTooltipDisabled]=\"_previousButtonsDisabled()\" [matTooltipPosition]=\"'above'\" [disabled]=\"_previousButtonsDisabled()\"><svg class=\"mat-paginator-icon\" viewBox=\"0 0 24 24\" focusable=\"false\"><path d=\"M15.41 7.41L14 6l-6 6 6 6 1.41-1.41L10.83 12z\"/></svg></button> <button mat-icon-button type=\"button\" class=\"mat-paginator-navigation-next\" (click)=\"nextPage()\" [attr.aria-label]=\"_intl.nextPageLabel\" [matTooltip]=\"_intl.nextPageLabel\" [matTooltipDisabled]=\"_nextButtonsDisabled()\" [matTooltipPosition]=\"'above'\" [disabled]=\"_nextButtonsDisabled()\"><svg class=\"mat-paginator-icon\" viewBox=\"0 0 24 24\" focusable=\"false\"><path d=\"M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z\"/></svg></button> <button mat-icon-button type=\"button\" class=\"mat-paginator-navigation-last\" (click)=\"lastPage()\" [attr.aria-label]=\"_intl.lastPageLabel\" [matTooltip]=\"_intl.lastPageLabel\" [matTooltipDisabled]=\"_nextButtonsDisabled()\" [matTooltipPosition]=\"'above'\" [disabled]=\"_nextButtonsDisabled()\" *ngIf=\"showFirstLastButtons\"><svg class=\"mat-paginator-icon\" viewBox=\"0 0 24 24\" focusable=\"false\"><path d=\"M5.59 7.41L10.18 12l-4.59 4.59L7 18l6-6-6-6zM16 6h2v12h-2z\"/></svg></button></div></div></div>",
styles: [".mat-paginator{display:block}.mat-paginator-outer-container{display:flex}.mat-paginator-container{display:flex;align-items:center;justify-content:flex-end;min-height:56px;padding:0 8px;flex-wrap:wrap-reverse;width:100%}.mat-paginator-page-size{display:flex;align-items:baseline;margin-right:8px}[dir=rtl] .mat-paginator-page-size{margin-right:0;margin-left:8px}.mat-paginator-page-size-label{margin:0 4px}.mat-paginator-page-size-select{margin:6px 4px 0 4px;width:56px}.mat-paginator-page-size-select.mat-form-field-appearance-outline{width:64px}.mat-paginator-page-size-select.mat-form-field-appearance-fill{width:64px}.mat-paginator-range-label{margin:0 32px 0 24px}.mat-paginator-range-actions{display:flex;align-items:center}.mat-paginator-icon{width:28px;fill:currentColor}[dir=rtl] .mat-paginator-icon{transform:rotate(180deg)}"],
inputs: ['disabled'],
host: {
'class': 'mat-paginator',
},
changeDetection: ChangeDetectionStrategy.OnPush,
encapsulation: ViewEncapsulation.None,
},] },
];
/** @nocollapse */
MatPaginator.ctorParameters = () => [
{ type: MatPaginatorIntl },
{ type: ChangeDetectorRef }
];
MatPaginator.propDecorators = {
color: [{ type: Input }],
pageIndex: [{ type: Input }],
length: [{ type: Input }],
pageSize: [{ type: Input }],
pageSizeOptions: [{ type: Input }],
hidePageSize: [{ type: Input }],
showFirstLastButtons: [{ type: Input }],
page: [{ type: Output }]
};
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
class MatPaginatorModule {
}
MatPaginatorModule.decorators = [
{ type: NgModule, args: [{
imports: [
CommonModule,
MatButtonModule,
MatSelectModule,
MatTooltipModule,
],
exports: [MatPaginator],
declarations: [MatPaginator],
providers: [MAT_PAGINATOR_INTL_PROVIDER],
},] },
];
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
export { MatPaginatorModule, PageEvent, MatPaginator, MAT_PAGINATOR_INTL_PROVIDER_FACTORY, MatPaginatorIntl, MAT_PAGINATOR_INTL_PROVIDER };
//# sourceMappingURL=paginator.js.map