@angular/material
Version:
Angular Material
606 lines (597 loc) • 24.6 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 { Attribute, ChangeDetectionStrategy, ChangeDetectorRef, Component, ElementRef, IterableDiffers, ViewEncapsulation, Directive, Input, NgModule } from '@angular/core';
import { CDK_TABLE_TEMPLATE, CdkTable, CdkCell, CdkCellDef, CdkColumnDef, CdkFooterCell, CdkFooterCellDef, CdkHeaderCell, CdkHeaderCellDef, CDK_ROW_TEMPLATE, CdkFooterRow, CdkFooterRowDef, CdkHeaderRow, CdkHeaderRowDef, CdkRow, CdkRowDef, CdkTableModule, DataSource } from '@angular/cdk/table';
import { CommonModule } from '@angular/common';
import { MatCommonModule } from '@angular/material/core';
import { _isNumberValue } from '@angular/cdk/coercion';
import { BehaviorSubject, combineLatest, merge, of } from 'rxjs';
import { map } from 'rxjs/operators';
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} checked by tsc
*/
/**
* Wrapper for the CdkTable with Material design styles.
* @template T
*/
class MatTable extends CdkTable {
/**
* @param {?} _differs
* @param {?} _changeDetectorRef
* @param {?} _elementRef
* @param {?} role
*/
constructor(_differs, _changeDetectorRef, _elementRef, role) {
super(_differs, _changeDetectorRef, _elementRef, role);
this._differs = _differs;
this._changeDetectorRef = _changeDetectorRef;
this._elementRef = _elementRef;
}
}
MatTable.decorators = [
{ type: Component, args: [{selector: 'mat-table, table[mat-table]',
exportAs: 'matTable',
template: CDK_TABLE_TEMPLATE,
styles: ["mat-table{display:block}mat-header-row{min-height:56px}mat-footer-row,mat-row{min-height:48px}mat-footer-row,mat-header-row,mat-row{display:flex;border-width:0;border-bottom-width:1px;border-style:solid;align-items:center;box-sizing:border-box}mat-footer-row::after,mat-header-row::after,mat-row::after{display:inline-block;min-height:inherit;content:''}mat-cell:first-child,mat-footer-cell:first-child,mat-header-cell:first-child{padding-left:24px}[dir=rtl] mat-cell:first-child,[dir=rtl] mat-footer-cell:first-child,[dir=rtl] mat-header-cell:first-child{padding-left:0;padding-right:24px}mat-cell:last-child,mat-footer-cell:last-child,mat-header-cell:last-child{padding-right:24px}[dir=rtl] mat-cell:last-child,[dir=rtl] mat-footer-cell:last-child,[dir=rtl] mat-header-cell:last-child{padding-right:0;padding-left:24px}mat-cell,mat-footer-cell,mat-header-cell{flex:1;display:flex;align-items:center;overflow:hidden;word-wrap:break-word;min-height:inherit}table.mat-table{border-spacing:0}tr.mat-header-row{height:56px}tr.mat-footer-row,tr.mat-row{height:48px}th.mat-header-cell{text-align:left}td.mat-cell,td.mat-footer-cell,th.mat-header-cell{padding:0;border-bottom-width:1px;border-bottom-style:solid}td.mat-cell:first-child,td.mat-footer-cell:first-child,th.mat-header-cell:first-child{padding-left:24px}td.mat-cell:last-child,td.mat-footer-cell:last-child,th.mat-header-cell:last-child{padding-right:24px}"],
host: {
'class': 'mat-table',
},
encapsulation: ViewEncapsulation.None,
changeDetection: ChangeDetectionStrategy.OnPush,
},] },
];
/** @nocollapse */
MatTable.ctorParameters = () => [
{ type: IterableDiffers, },
{ type: ChangeDetectorRef, },
{ type: ElementRef, },
{ type: undefined, decorators: [{ type: Attribute, args: ['role',] },] },
];
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} checked by tsc
*/
/**
* Cell definition for the mat-table.
* Captures the template of a column's data row cell as well as cell-specific properties.
*/
class MatCellDef extends CdkCellDef {
}
MatCellDef.decorators = [
{ type: Directive, args: [{
selector: '[matCellDef]',
providers: [{ provide: CdkCellDef, useExisting: MatCellDef }]
},] },
];
/**
* Header cell definition for the mat-table.
* Captures the template of a column's header cell and as well as cell-specific properties.
*/
class MatHeaderCellDef extends CdkHeaderCellDef {
}
MatHeaderCellDef.decorators = [
{ type: Directive, args: [{
selector: '[matHeaderCellDef]',
providers: [{ provide: CdkHeaderCellDef, useExisting: MatHeaderCellDef }]
},] },
];
/**
* Footer cell definition for the mat-table.
* Captures the template of a column's footer cell and as well as cell-specific properties.
*/
class MatFooterCellDef extends CdkFooterCellDef {
}
MatFooterCellDef.decorators = [
{ type: Directive, args: [{
selector: '[matFooterCellDef]',
providers: [{ provide: CdkFooterCellDef, useExisting: MatFooterCellDef }]
},] },
];
/**
* Column definition for the mat-table.
* Defines a set of cells available for a table column.
*/
class MatColumnDef extends CdkColumnDef {
}
MatColumnDef.decorators = [
{ type: Directive, args: [{
selector: '[matColumnDef]',
providers: [{ provide: CdkColumnDef, useExisting: MatColumnDef }],
},] },
];
/** @nocollapse */
MatColumnDef.propDecorators = {
"name": [{ type: Input, args: ['matColumnDef',] },],
};
/**
* Header cell template container that adds the right classes and role.
*/
class MatHeaderCell extends CdkHeaderCell {
/**
* @param {?} columnDef
* @param {?} elementRef
*/
constructor(columnDef, elementRef) {
super(columnDef, elementRef);
elementRef.nativeElement.classList.add(`mat-column-${columnDef.cssClassFriendlyName}`);
}
}
MatHeaderCell.decorators = [
{ type: Directive, args: [{
selector: 'mat-header-cell, th[mat-header-cell]',
host: {
'class': 'mat-header-cell',
'role': 'columnheader',
},
},] },
];
/** @nocollapse */
MatHeaderCell.ctorParameters = () => [
{ type: CdkColumnDef, },
{ type: ElementRef, },
];
/**
* Footer cell template container that adds the right classes and role.
*/
class MatFooterCell extends CdkFooterCell {
/**
* @param {?} columnDef
* @param {?} elementRef
*/
constructor(columnDef, elementRef) {
super(columnDef, elementRef);
elementRef.nativeElement.classList.add(`mat-column-${columnDef.cssClassFriendlyName}`);
}
}
MatFooterCell.decorators = [
{ type: Directive, args: [{
selector: 'mat-footer-cell, td[mat-footer-cell]',
host: {
'class': 'mat-footer-cell',
'role': 'gridcell',
},
},] },
];
/** @nocollapse */
MatFooterCell.ctorParameters = () => [
{ type: CdkColumnDef, },
{ type: ElementRef, },
];
/**
* Cell template container that adds the right classes and role.
*/
class MatCell extends CdkCell {
/**
* @param {?} columnDef
* @param {?} elementRef
*/
constructor(columnDef, elementRef) {
super(columnDef, elementRef);
elementRef.nativeElement.classList.add(`mat-column-${columnDef.cssClassFriendlyName}`);
}
}
MatCell.decorators = [
{ type: Directive, args: [{
selector: 'mat-cell, td[mat-cell]',
host: {
'class': 'mat-cell',
'role': 'gridcell',
},
},] },
];
/** @nocollapse */
MatCell.ctorParameters = () => [
{ type: CdkColumnDef, },
{ type: ElementRef, },
];
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} checked by tsc
*/
/**
* Header row definition for the mat-table.
* Captures the header row's template and other header properties such as the columns to display.
*/
class MatHeaderRowDef extends CdkHeaderRowDef {
}
MatHeaderRowDef.decorators = [
{ type: Directive, args: [{
selector: '[matHeaderRowDef]',
providers: [{ provide: CdkHeaderRowDef, useExisting: MatHeaderRowDef }],
inputs: ['columns: matHeaderRowDef'],
},] },
];
/**
* Footer row definition for the mat-table.
* Captures the footer row's template and other footer properties such as the columns to display.
*/
class MatFooterRowDef extends CdkFooterRowDef {
}
MatFooterRowDef.decorators = [
{ type: Directive, args: [{
selector: '[matFooterRowDef]',
providers: [{ provide: CdkFooterRowDef, useExisting: MatFooterRowDef }],
inputs: ['columns: matFooterRowDef'],
},] },
];
/**
* Data row definition for the mat-table.
* Captures the footer row's template and other footer properties such as the columns to display and
* a when predicate that describes when this row should be used.
* @template T
*/
class MatRowDef extends CdkRowDef {
}
MatRowDef.decorators = [
{ type: Directive, args: [{
selector: '[matRowDef]',
providers: [{ provide: CdkRowDef, useExisting: MatRowDef }],
inputs: ['columns: matRowDefColumns', 'when: matRowDefWhen'],
},] },
];
/**
* Footer template container that contains the cell outlet. Adds the right class and role.
*/
class MatHeaderRow extends CdkHeaderRow {
}
MatHeaderRow.decorators = [
{ type: Component, args: [{selector: 'mat-header-row, tr[mat-header-row]',
template: CDK_ROW_TEMPLATE,
host: {
'class': 'mat-header-row',
'role': 'row',
},
changeDetection: ChangeDetectionStrategy.OnPush,
encapsulation: ViewEncapsulation.None,
exportAs: 'matHeaderRow',
},] },
];
/**
* Footer template container that contains the cell outlet. Adds the right class and role.
*/
class MatFooterRow extends CdkFooterRow {
}
MatFooterRow.decorators = [
{ type: Component, args: [{selector: 'mat-footer-row, tr[mat-footer-row]',
template: CDK_ROW_TEMPLATE,
host: {
'class': 'mat-footer-row',
'role': 'row',
},
changeDetection: ChangeDetectionStrategy.OnPush,
encapsulation: ViewEncapsulation.None,
exportAs: 'matFooterRow',
},] },
];
/**
* Data row template container that contains the cell outlet. Adds the right class and role.
*/
class MatRow extends CdkRow {
}
MatRow.decorators = [
{ type: Component, args: [{selector: 'mat-row, tr[mat-row]',
template: CDK_ROW_TEMPLATE,
host: {
'class': 'mat-row',
'role': 'row',
},
changeDetection: ChangeDetectionStrategy.OnPush,
encapsulation: ViewEncapsulation.None,
exportAs: 'matRow',
},] },
];
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} checked by tsc
*/
const /** @type {?} */ EXPORTED_DECLARATIONS = [
MatTable,
MatHeaderCellDef,
MatHeaderRowDef,
MatColumnDef,
MatCellDef,
MatRowDef,
MatFooterCellDef,
MatFooterRowDef,
MatHeaderCell,
MatCell,
MatFooterCell,
MatHeaderRow,
MatRow,
MatFooterRow,
];
class MatTableModule {
}
MatTableModule.decorators = [
{ type: NgModule, args: [{
imports: [CdkTableModule, CommonModule, MatCommonModule],
exports: EXPORTED_DECLARATIONS,
declarations: EXPORTED_DECLARATIONS,
},] },
];
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} checked by tsc
*/
/**
* Data source that accepts a client-side data array and includes native support of filtering,
* sorting (using MatSort), and pagination (using MatPaginator).
*
* Allows for sort customization by overriding sortingDataAccessor, which defines how data
* properties are accessed. Also allows for filter customization by overriding filterTermAccessor,
* which defines how row data is converted to a string for filter matching.
* @template T
*/
class MatTableDataSource extends DataSource {
/**
* @param {?=} initialData
*/
constructor(initialData = []) {
super();
/**
* Stream emitting render data to the table (depends on ordered data changes).
*/
this._renderData = new BehaviorSubject([]);
/**
* Stream that emits when a new filter string is set on the data source.
*/
this._filter = new BehaviorSubject('');
/**
* Data accessor function that is used for accessing data properties for sorting through
* the default sortData function.
* This default function assumes that the sort header IDs (which defaults to the column name)
* matches the data's properties (e.g. column Xyz represents data['Xyz']).
* May be set to a custom function for different behavior.
* @param data Data object that is being accessed.
* @param sortHeaderId The name of the column that represents the data.
*/
this.sortingDataAccessor = (data, sortHeaderId) => {
const /** @type {?} */ value = data[sortHeaderId];
return _isNumberValue(value) ? Number(value) : value;
};
/**
* Gets a sorted copy of the data array based on the state of the MatSort. Called
* after changes are made to the filtered data or when sort changes are emitted from MatSort.
* By default, the function retrieves the active sort and its direction and compares data
* by retrieving data using the sortingDataAccessor. May be overridden for a custom implementation
* of data ordering.
* @param data The array of data that should be sorted.
* @param sort The connected MatSort that holds the current sort state.
*/
this.sortData = (data, sort) => {
const /** @type {?} */ active = sort.active;
const /** @type {?} */ direction = sort.direction;
if (!active || direction == '') {
return data;
}
return data.sort((a, b) => {
let /** @type {?} */ valueA = this.sortingDataAccessor(a, active);
let /** @type {?} */ valueB = this.sortingDataAccessor(b, active);
// If both valueA and valueB exist (truthy), then compare the two. Otherwise, check if
// one value exists while the other doesn't. In this case, existing value should come first.
// This avoids inconsistent results when comparing values to undefined/null.
// If neither value exists, return 0 (equal).
let /** @type {?} */ comparatorResult = 0;
if (valueA != null && valueB != null) {
// Check if one value is greater than the other; if equal, comparatorResult should remain 0.
if (valueA > valueB) {
comparatorResult = 1;
}
else if (valueA < valueB) {
comparatorResult = -1;
}
}
else if (valueA != null) {
comparatorResult = 1;
}
else if (valueB != null) {
comparatorResult = -1;
}
return comparatorResult * (direction == 'asc' ? 1 : -1);
});
};
/**
* Checks if a data object matches the data source's filter string. By default, each data object
* is converted to a string of its properties and returns true if the filter has
* at least one occurrence in that string. By default, the filter string has its whitespace
* trimmed and the match is case-insensitive. May be overridden for a custom implementation of
* filter matching.
* @param data Data object used to check against the filter.
* @param filter Filter string that has been set on the data source.
* @return Whether the filter matches against the data
*/
this.filterPredicate = (data, filter) => {
// Transform the data into a lowercase string of all property values.
const /** @type {?} */ accumulator = (currentTerm, key) => currentTerm + data[key];
const /** @type {?} */ dataStr = Object.keys(data).reduce(accumulator, '').toLowerCase();
// Transform the filter by converting it to lowercase and removing whitespace.
const /** @type {?} */ transformedFilter = filter.trim().toLowerCase();
return dataStr.indexOf(transformedFilter) != -1;
};
this._data = new BehaviorSubject(initialData);
this._updateChangeSubscription();
}
/**
* Array of data that should be rendered by the table, where each object represents one row.
* @return {?}
*/
get data() { return this._data.value; }
/**
* @param {?} data
* @return {?}
*/
set data(data) { this._data.next(data); }
/**
* Filter term that should be used to filter out objects from the data array. To override how
* data objects match to this filter string, provide a custom function for filterPredicate.
* @return {?}
*/
get filter() { return this._filter.value; }
/**
* @param {?} filter
* @return {?}
*/
set filter(filter) { this._filter.next(filter); }
/**
* Instance of the MatSort directive used by the table to control its sorting. Sort changes
* emitted by the MatSort will trigger an update to the table's rendered data.
* @return {?}
*/
get sort() { return this._sort; }
/**
* @param {?} sort
* @return {?}
*/
set sort(sort) {
this._sort = sort;
this._updateChangeSubscription();
}
/**
* Instance of the MatPaginator component used by the table to control what page of the data is
* displayed. Page changes emitted by the MatPaginator will trigger an update to the
* table's rendered data.
*
* Note that the data source uses the paginator's properties to calculate which page of data
* should be displayed. If the paginator receives its properties as template inputs,
* e.g. `[pageLength]=100` or `[pageIndex]=1`, then be sure that the paginator's view has been
* initialized before assigning it to this data source.
* @return {?}
*/
get paginator() { return this._paginator; }
/**
* @param {?} paginator
* @return {?}
*/
set paginator(paginator) {
this._paginator = paginator;
this._updateChangeSubscription();
}
/**
* Subscribe to changes that should trigger an update to the table's rendered rows. When the
* changes occur, process the current state of the filter, sort, and pagination along with
* the provided base data and send it to the table for rendering.
* @return {?}
*/
_updateChangeSubscription() {
// Sorting and/or pagination should be watched if MatSort and/or MatPaginator are provided.
// The events should emit whenever the component emits a change or initializes, or if no
// component is provided, a stream with just a null event should be provided.
// The `sortChange` and `pageChange` acts as a signal to the combineLatests below so that the
// pipeline can progress to the next step. Note that the value from these streams are not used,
// they purely act as a signal to progress in the pipeline.
const /** @type {?} */ sortChange = this._sort ?
merge(this._sort.sortChange, this._sort.initialized) :
of(null);
const /** @type {?} */ pageChange = this._paginator ?
merge(this._paginator.page, this._paginator.initialized) :
of(null);
if (this._renderChangesSubscription) {
this._renderChangesSubscription.unsubscribe();
}
const /** @type {?} */ dataStream = this._data;
// Watch for base data or filter changes to provide a filtered set of data.
const /** @type {?} */ filteredData = combineLatest(dataStream, this._filter)
.pipe(map(([data]) => this._filterData(data)));
// Watch for filtered data or sort changes to provide an ordered set of data.
const /** @type {?} */ orderedData = combineLatest(filteredData, sortChange)
.pipe(map(([data]) => this._orderData(data)));
// Watch for ordered data or page changes to provide a paged set of data.
const /** @type {?} */ paginatedData = combineLatest(orderedData, pageChange)
.pipe(map(([data]) => this._pageData(data)));
// Watched for paged data changes and send the result to the table to render.
paginatedData.subscribe(data => this._renderData.next(data));
}
/**
* Returns a filtered data array where each filter object contains the filter string within
* the result of the filterTermAccessor function. If no filter is set, returns the data array
* as provided.
* @param {?} data
* @return {?}
*/
_filterData(data) {
// If there is a filter string, filter out data that does not contain it.
// Each data object is converted to a string using the function defined by filterTermAccessor.
// May be overridden for customization.
this.filteredData =
!this.filter ? data : data.filter(obj => this.filterPredicate(obj, this.filter));
if (this.paginator) {
this._updatePaginator(this.filteredData.length);
}
return this.filteredData;
}
/**
* Returns a sorted copy of the data if MatSort has a sort applied, otherwise just returns the
* data array as provided. Uses the default data accessor for data lookup, unless a
* sortDataAccessor function is defined.
* @param {?} data
* @return {?}
*/
_orderData(data) {
// If there is no active sort or direction, return the data without trying to sort.
if (!this.sort) {
return data;
}
return this.sortData(data.slice(), this.sort);
}
/**
* Returns a paged splice of the provided data array according to the provided MatPaginator's page
* index and length. If there is no paginator provided, returns the data array as provided.
* @param {?} data
* @return {?}
*/
_pageData(data) {
if (!this.paginator) {
return data;
}
const /** @type {?} */ startIndex = this.paginator.pageIndex * this.paginator.pageSize;
return data.slice().splice(startIndex, this.paginator.pageSize);
}
/**
* Updates the paginator to reflect the length of the filtered data, and makes sure that the page
* index does not exceed the paginator's last page. Values are changed in a resolved promise to
* guard against making property changes within a round of change detection.
* @param {?} filteredDataLength
* @return {?}
*/
_updatePaginator(filteredDataLength) {
Promise.resolve().then(() => {
if (!this.paginator) {
return;
}
this.paginator.length = filteredDataLength;
// If the page index is set beyond the page, reduce it to the last page.
if (this.paginator.pageIndex > 0) {
const /** @type {?} */ lastPageIndex = Math.ceil(this.paginator.length / this.paginator.pageSize) - 1 || 0;
this.paginator.pageIndex = Math.min(this.paginator.pageIndex, lastPageIndex);
}
});
}
/**
* Used by the MatTable. Called when it connects to the data source.
* \@docs-private
* @return {?}
*/
connect() { return this._renderData; }
/**
* Used by the MatTable. Called when it is destroyed. No-op.
* \@docs-private
* @return {?}
*/
disconnect() { }
}
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} checked by tsc
*/
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} checked by tsc
*/
export { MatTableModule, MatCellDef, MatHeaderCellDef, MatFooterCellDef, MatColumnDef, MatHeaderCell, MatFooterCell, MatCell, MatTable, MatHeaderRowDef, MatFooterRowDef, MatRowDef, MatHeaderRow, MatFooterRow, MatRow, MatTableDataSource };
//# sourceMappingURL=table.js.map