@angular/material 14.0.0-next.9 → 14.0.0-rc.0

package/paginator/index.d.ts

@@ -1,8 +1,226 @@
+import { _AbstractConstructor } from '@angular/material/core';
+import { BooleanInput } from '@angular/cdk/coercion';
+import { CanDisable } from '@angular/material/core';
+import { ChangeDetectorRef } from '@angular/core';
+import { _Constructor } from '@angular/material/core';
+import { EventEmitter } from '@angular/core';
+import { HasInitialized } from '@angular/material/core';
+import * as i0 from '@angular/core';
+import * as i2 from '@angular/common';
+import * as i3 from '@angular/material/button';
+import * as i4 from '@angular/material/select';
+import * as i5 from '@angular/material/tooltip';
+import * as i6 from '@angular/material/core';
+import { InjectionToken } from '@angular/core';
+import { MatFormFieldAppearance } from '@angular/material/form-field';
+import { NumberInput } from '@angular/cdk/coercion';
+import { OnDestroy } from '@angular/core';
+import { OnInit } from '@angular/core';
+import { Optional } from '@angular/core';
+import { Subject } from 'rxjs';
+import { ThemePalette } from '@angular/material/core';
+
+declare namespace i1 {
+    export {
+        PageEvent,
+        MatPaginatorDefaultOptions,
+        MAT_PAGINATOR_DEFAULT_OPTIONS,
+        MatPaginatorSelectConfig,
+        _MatPaginatorBase,
+        MatPaginator
+    }
+}
+
+/** Injection token that can be used to provide the default options for the paginator module. */
+export declare const MAT_PAGINATOR_DEFAULT_OPTIONS: InjectionToken<MatPaginatorDefaultOptions>;
+
+/** @docs-private */
+export declare const MAT_PAGINATOR_INTL_PROVIDER: {
+    provide: typeof MatPaginatorIntl;
+    deps: Optional[][];
+    useFactory: typeof MAT_PAGINATOR_INTL_PROVIDER_FACTORY;
+};
+
+/** @docs-private */
+export declare function MAT_PAGINATOR_INTL_PROVIDER_FACTORY(parentIntl: MatPaginatorIntl): MatPaginatorIntl;
+
 /**
- * @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
+ * 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.
  */
-export * from './public-api';
+export declare class MatPaginator extends _MatPaginatorBase<MatPaginatorDefaultOptions> {
+    /** If set, styles the "page size" form field with the designated style. */
+    _formFieldAppearance?: MatFormFieldAppearance;
+    constructor(intl: MatPaginatorIntl, changeDetectorRef: ChangeDetectorRef, defaults?: MatPaginatorDefaultOptions);
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatPaginator, [null, null, { optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatPaginator, "mat-paginator", ["matPaginator"], { "disabled": "disabled"; }, {}, never, never, false>;
+}
+
+/**
+ * Base class with all of the `MatPaginator` functionality.
+ * @docs-private
+ */
+export declare abstract class _MatPaginatorBase<O extends {
+    pageSize?: number;
+    pageSizeOptions?: number[];
+    hidePageSize?: boolean;
+    showFirstLastButtons?: boolean;
+}> extends _MatPaginatorMixinBase implements OnInit, OnDestroy, CanDisable, HasInitialized {
+    _intl: MatPaginatorIntl;
+    private _changeDetectorRef;
+    private _initialized;
+    private _intlChanges;
+    /** Theme color to be used for the underlying form controls. */
+    color: ThemePalette;
+    /** The zero-based page index of the displayed list of items. Defaulted to 0. */
+    get pageIndex(): number;
+    set pageIndex(value: NumberInput);
+    private _pageIndex;
+    /** The length of the total number of items that are being paginated. Defaulted to 0. */
+    get length(): number;
+    set length(value: NumberInput);
+    private _length;
+    /** Number of items to display on a page. By default set to 50. */
+    get pageSize(): number;
+    set pageSize(value: NumberInput);
+    private _pageSize;
+    /** The set of provided page size options to display to the user. */
+    get pageSizeOptions(): number[];
+    set pageSizeOptions(value: number[] | readonly number[]);
+    private _pageSizeOptions;
+    /** Whether to hide the page size selection UI from the user. */
+    get hidePageSize(): boolean;
+    set hidePageSize(value: BooleanInput);
+    private _hidePageSize;
+    /** Whether to show the first/last buttons UI to the user. */
+    get showFirstLastButtons(): boolean;
+    set showFirstLastButtons(value: BooleanInput);
+    private _showFirstLastButtons;
+    /** Used to configure the underlying `MatSelect` inside the paginator. */
+    selectConfig: MatPaginatorSelectConfig;
+    /** Event emitted when the paginator changes the page size or page index. */
+    readonly page: EventEmitter<PageEvent>;
+    /** Displayed set of page size options. Will be sorted and include current page size. */
+    _displayedPageSizeOptions: number[];
+    constructor(_intl: MatPaginatorIntl, _changeDetectorRef: ChangeDetectorRef, defaults?: O);
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    /** Advances to the next page if it exists. */
+    nextPage(): void;
+    /** Move back to the previous page if it exists. */
+    previousPage(): void;
+    /** Move to the first page if not already there. */
+    firstPage(): void;
+    /** Move to the last page if not already there. */
+    lastPage(): void;
+    /** Whether there is a previous page. */
+    hasPreviousPage(): boolean;
+    /** Whether there is a next page. */
+    hasNextPage(): boolean;
+    /** Calculate the number of pages */
+    getNumberOfPages(): number;
+    /**
+     * 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.
+     */
+    _changePageSize(pageSize: number): void;
+    /** Checks whether the buttons for going forwards should be disabled. */
+    _nextButtonsDisabled(): boolean;
+    /** Checks whether the buttons for going backwards should be disabled. */
+    _previousButtonsDisabled(): boolean;
+    /**
+     * 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 _updateDisplayedPageSizeOptions;
+    /** Emits an event notifying that a change of the paginator's properties has been triggered. */
+    private _emitPageEvent;
+    static ɵfac: i0.ɵɵFactoryDeclaration<_MatPaginatorBase<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<_MatPaginatorBase<any>, never, never, { "color": "color"; "pageIndex": "pageIndex"; "length": "length"; "pageSize": "pageSize"; "pageSizeOptions": "pageSizeOptions"; "hidePageSize": "hidePageSize"; "showFirstLastButtons": "showFirstLastButtons"; "selectConfig": "selectConfig"; }, { "page": "page"; }, never, never, false>;
+}
+
+/** Object that can be used to configure the default options for the paginator module. */
+export declare interface MatPaginatorDefaultOptions {
+    /** Number of items to display on a page. By default set to 50. */
+    pageSize?: number;
+    /** The set of provided page size options to display to the user. */
+    pageSizeOptions?: number[];
+    /** Whether to hide the page size selection UI from the user. */
+    hidePageSize?: boolean;
+    /** Whether to show the first/last buttons UI to the user. */
+    showFirstLastButtons?: boolean;
+    /** The default form-field appearance to apply to the page size options selector. */
+    formFieldAppearance?: MatFormFieldAppearance;
+}
+
+/**
+ * To modify the labels and text displayed, create a new instance of MatPaginatorIntl and
+ * include it in a custom provider
+ */
+export declare class MatPaginatorIntl {
+    /**
+     * Stream to emit from when labels are changed. Use this to notify components when the labels have
+     * changed after initialization.
+     */
+    readonly changes: Subject<void>;
+    /** A label for the page size selector. */
+    itemsPerPageLabel: string;
+    /** A label for the button that increments the current page. */
+    nextPageLabel: string;
+    /** A label for the button that decrements the current page. */
+    previousPageLabel: string;
+    /** A label for the button that moves to the first page. */
+    firstPageLabel: string;
+    /** A label for the button that moves to the last page. */
+    lastPageLabel: string;
+    /** A label for the range of items within the current page and the length of the whole list. */
+    getRangeLabel: (page: number, pageSize: number, length: number) => string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatPaginatorIntl, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MatPaginatorIntl>;
+}
+
+/** @docs-private */
+declare const _MatPaginatorMixinBase: _Constructor<CanDisable> & _AbstractConstructor<CanDisable> & (new (...args: any[]) => HasInitialized) & {
+    new (): {};
+};
+
+export declare class MatPaginatorModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatPaginatorModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MatPaginatorModule, [typeof i1.MatPaginator], [typeof i2.CommonModule, typeof i3.MatButtonModule, typeof i4.MatSelectModule, typeof i5.MatTooltipModule, typeof i6.MatCommonModule], [typeof i1.MatPaginator]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<MatPaginatorModule>;
+}
+
+/** Object that can used to configure the underlying `MatSelect` inside a `MatPaginator`. */
+export declare interface MatPaginatorSelectConfig {
+    /** Whether to center the active option over the trigger. */
+    disableOptionCentering?: boolean;
+    /** Classes to be passed to the select panel. */
+    panelClass?: string | string[] | Set<string> | {
+        [key: string]: any;
+    };
+}
+
+/**
+ * Change event object that is emitted when the user selects a
+ * different page size or navigates to another page.
+ */
+export declare class PageEvent {
+    /** The current page index. */
+    pageIndex: number;
+    /**
+     * Index of the page that was selected previously.
+     * @breaking-change 8.0.0 To be made into a required property.
+     */
+    previousPageIndex?: number;
+    /** The current page size */
+    pageSize: number;
+    /** The current total number of items being paged */
+    length: number;
+}
+
+export { }

package/paginator/testing/index.d.ts

@@ -1,8 +1,65 @@
-/**
- * @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
- */
-export * from './public-api';
+import { AsyncFactoryFn } from '@angular/cdk/testing';
+import { BaseHarnessFilters } from '@angular/cdk/testing';
+import { ComponentHarness } from '@angular/cdk/testing';
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { MatSelectHarness } from '@angular/material/select/testing';
+import { TestElement } from '@angular/cdk/testing';
+
+/** Harness for interacting with a standard mat-paginator in tests. */
+export declare class MatPaginatorHarness extends _MatPaginatorHarnessBase {
+    /** Selector used to find paginator instances. */
+    static hostSelector: string;
+    protected _nextButton: AsyncFactoryFn<TestElement>;
+    protected _previousButton: AsyncFactoryFn<TestElement>;
+    protected _firstPageButton: AsyncFactoryFn<TestElement | null>;
+    protected _lastPageButton: AsyncFactoryFn<TestElement | null>;
+    protected _select: AsyncFactoryFn<MatSelectHarness | null>;
+    protected _pageSizeFallback: AsyncFactoryFn<TestElement>;
+    protected _rangeLabel: AsyncFactoryFn<TestElement>;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a `MatPaginatorHarness` that meets
+     * certain criteria.
+     * @param options Options for filtering which paginator instances are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: PaginatorHarnessFilters): HarnessPredicate<MatPaginatorHarness>;
+}
+
+export declare abstract class _MatPaginatorHarnessBase extends ComponentHarness {
+    protected abstract _nextButton: AsyncFactoryFn<TestElement>;
+    protected abstract _previousButton: AsyncFactoryFn<TestElement>;
+    protected abstract _firstPageButton: AsyncFactoryFn<TestElement | null>;
+    protected abstract _lastPageButton: AsyncFactoryFn<TestElement | null>;
+    protected abstract _select: AsyncFactoryFn<(ComponentHarness & {
+        getValueText(): Promise<string>;
+        clickOptions(...filters: unknown[]): Promise<void>;
+    }) | null>;
+    protected abstract _pageSizeFallback: AsyncFactoryFn<TestElement>;
+    protected abstract _rangeLabel: AsyncFactoryFn<TestElement>;
+    /** Goes to the next page in the paginator. */
+    goToNextPage(): Promise<void>;
+    /** Returns whether or not the next page button is disabled. */
+    isNextPageDisabled(): Promise<boolean>;
+    isPreviousPageDisabled(): Promise<boolean>;
+    /** Goes to the previous page in the paginator. */
+    goToPreviousPage(): Promise<void>;
+    /** Goes to the first page in the paginator. */
+    goToFirstPage(): Promise<void>;
+    /** Goes to the last page in the paginator. */
+    goToLastPage(): Promise<void>;
+    /**
+     * Sets the page size of the paginator.
+     * @param size Page size that should be select.
+     */
+    setPageSize(size: number): Promise<void>;
+    /** Gets the page size of the paginator. */
+    getPageSize(): Promise<number>;
+    /** Gets the text of the range labe of the paginator. */
+    getRangeLabel(): Promise<string>;
+}
+
+/** A set of criteria that can be used to filter a list of `MatPaginatorHarness` instances. */
+export declare interface PaginatorHarnessFilters extends BaseHarnessFilters {
+}
+
+export { }