devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
622 lines (539 loc) • 21 kB
JavaScript
import * as i0 from '@angular/core';
import { PLATFORM_ID, Component, Inject, Input, Output, NgModule } from '@angular/core';
import DxPagination from 'devextreme/ui/pagination';
import * as i1 from 'devextreme-angular/core';
import { DxComponent, DxTemplateHost, WatcherHelper, NestedOptionHost, IterableDifferHelper, DxIntegrationModule, DxTemplateModule } from 'devextreme-angular/core';
/*!
* devextreme-angular
* Version: 24.2.6
* Build date: Mon Mar 17 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-angular
*/
/* tslint:disable:max-line-length */
/**
* Pagination is a UI component that allows users to navigate through pages and change page size at runtime. Pagination UI includes a page navigator and several optional elements: a page size selector, navigation buttons, and page information.
*/
class DxPaginationComponent extends DxComponent {
_watcherHelper;
_idh;
instance = null;
/**
* Specifies the shortcut key that sets focus on the UI component.
*/
get accessKey() {
return this._getOption('accessKey');
}
set accessKey(value) {
this._setOption('accessKey', value);
}
/**
* Specifies whether the UI component changes its visual state as a result of user interaction.
*/
get activeStateEnabled() {
return this._getOption('activeStateEnabled');
}
set activeStateEnabled(value) {
this._setOption('activeStateEnabled', value);
}
/**
* Specifies page sizes available in the page size selector.
*/
get allowedPageSizes() {
return this._getOption('allowedPageSizes');
}
set allowedPageSizes(value) {
this._setOption('allowedPageSizes', value);
}
/**
* Specifies whether the UI component responds to user interaction.
*/
get disabled() {
return this._getOption('disabled');
}
set disabled(value) {
this._setOption('disabled', value);
}
/**
* Specifies the pager's display mode.
*/
get displayMode() {
return this._getOption('displayMode');
}
set displayMode(value) {
this._setOption('displayMode', value);
}
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
get elementAttr() {
return this._getOption('elementAttr');
}
set elementAttr(value) {
this._setOption('elementAttr', value);
}
/**
* Specifies whether the UI component can be focused using keyboard navigation.
*/
get focusStateEnabled() {
return this._getOption('focusStateEnabled');
}
set focusStateEnabled(value) {
this._setOption('focusStateEnabled', value);
}
/**
* Specifies the UI component's height.
*/
get height() {
return this._getOption('height');
}
set height(value) {
this._setOption('height', value);
}
/**
* Specifies text for a hint that appears when a user pauses on the UI component.
*/
get hint() {
return this._getOption('hint');
}
set hint(value) {
this._setOption('hint', value);
}
/**
* Specifies whether the UI component changes its state when a user pauses on it.
*/
get hoverStateEnabled() {
return this._getOption('hoverStateEnabled');
}
set hoverStateEnabled(value) {
this._setOption('hoverStateEnabled', value);
}
/**
* Specifies the page information text.
*/
get infoText() {
return this._getOption('infoText');
}
set infoText(value) {
this._setOption('infoText', value);
}
/**
* Specifies the total number of items.
*/
get itemCount() {
return this._getOption('itemCount');
}
set itemCount(value) {
this._setOption('itemCount', value);
}
/**
* Specifies an aria-label attribute for the pager.
*/
get label() {
return this._getOption('label');
}
set label(value) {
this._setOption('label', value);
}
/**
* Specifies the page index.
*/
get pageIndex() {
return this._getOption('pageIndex');
}
set pageIndex(value) {
this._setOption('pageIndex', value);
}
/**
* Specifies the page size.
*/
get pageSize() {
return this._getOption('pageSize');
}
set pageSize(value) {
this._setOption('pageSize', value);
}
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled() {
return this._getOption('rtlEnabled');
}
set rtlEnabled(value) {
this._setOption('rtlEnabled', value);
}
/**
* Specifies whether to show the page information.
*/
get showInfo() {
return this._getOption('showInfo');
}
set showInfo(value) {
this._setOption('showInfo', value);
}
/**
* Specifies whether to show navigation buttons.
*/
get showNavigationButtons() {
return this._getOption('showNavigationButtons');
}
set showNavigationButtons(value) {
this._setOption('showNavigationButtons', value);
}
/**
* Specifies whether to show the page size selector.
*/
get showPageSizeSelector() {
return this._getOption('showPageSizeSelector');
}
set showPageSizeSelector(value) {
this._setOption('showPageSizeSelector', value);
}
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
get tabIndex() {
return this._getOption('tabIndex');
}
set tabIndex(value) {
this._setOption('tabIndex', value);
}
/**
* Specifies whether the UI component is visible.
*/
get visible() {
return this._getOption('visible');
}
set visible(value) {
this._setOption('visible', value);
}
/**
* Specifies the UI component's width.
*/
get width() {
return this._getOption('width');
}
set width(value) {
this._setOption('width', value);
}
/**
* A function that is executed when the UI component is rendered and each time the component is repainted.
*/
onContentReady;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
accessKeyChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
activeStateEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
allowedPageSizesChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
disabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
displayModeChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
elementAttrChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
focusStateEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
heightChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hintChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hoverStateEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
infoTextChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
itemCountChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
labelChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
pageIndexChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
pageSizeChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
rtlEnabledChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showInfoChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showNavigationButtonsChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showPageSizeSelectorChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
tabIndexChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
visibleChange;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
widthChange;
constructor(elementRef, ngZone, templateHost, _watcherHelper, _idh, optionHost, transferState, platformId) {
super(elementRef, ngZone, templateHost, _watcherHelper, transferState, platformId);
this._watcherHelper = _watcherHelper;
this._idh = _idh;
this._createEventEmitters([
{ subscribe: 'contentReady', emit: 'onContentReady' },
{ subscribe: 'disposing', emit: 'onDisposing' },
{ subscribe: 'initialized', emit: 'onInitialized' },
{ subscribe: 'optionChanged', emit: 'onOptionChanged' },
{ emit: 'accessKeyChange' },
{ emit: 'activeStateEnabledChange' },
{ emit: 'allowedPageSizesChange' },
{ emit: 'disabledChange' },
{ emit: 'displayModeChange' },
{ emit: 'elementAttrChange' },
{ emit: 'focusStateEnabledChange' },
{ emit: 'heightChange' },
{ emit: 'hintChange' },
{ emit: 'hoverStateEnabledChange' },
{ emit: 'infoTextChange' },
{ emit: 'itemCountChange' },
{ emit: 'labelChange' },
{ emit: 'pageIndexChange' },
{ emit: 'pageSizeChange' },
{ emit: 'rtlEnabledChange' },
{ emit: 'showInfoChange' },
{ emit: 'showNavigationButtonsChange' },
{ emit: 'showPageSizeSelectorChange' },
{ emit: 'tabIndexChange' },
{ emit: 'visibleChange' },
{ emit: 'widthChange' }
]);
this._idh.setHost(this);
optionHost.setHost(this);
}
_createInstance(element, options) {
return new DxPagination(element, options);
}
ngOnDestroy() {
this._destroyWidget();
}
ngOnChanges(changes) {
super.ngOnChanges(changes);
this.setupChanges('allowedPageSizes', changes);
}
setupChanges(prop, changes) {
if (!(prop in this._optionsToUpdate)) {
this._idh.setup(prop, changes);
}
}
ngDoCheck() {
this._idh.doCheck('allowedPageSizes');
this._watcherHelper.checkWatchers();
super.ngDoCheck();
super.clearChangedOptions();
}
_setOption(name, value) {
let isSetup = this._idh.setupSingle(name, value);
let isChanged = this._idh.getChanges(name, value) !== null;
if (isSetup || isChanged) {
super._setOption(name, value);
}
}
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxPaginationComponent, deps: [{ token: i0.ElementRef }, { token: i0.NgZone }, { token: i1.DxTemplateHost }, { token: i1.WatcherHelper }, { token: i1.IterableDifferHelper }, { token: i1.NestedOptionHost }, { token: i0.TransferState }, { token: PLATFORM_ID }], target: i0.ɵɵFactoryTarget.Component });
/** @nocollapse */ static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "17.3.12", type: DxPaginationComponent, selector: "dx-pagination", inputs: { accessKey: "accessKey", activeStateEnabled: "activeStateEnabled", allowedPageSizes: "allowedPageSizes", disabled: "disabled", displayMode: "displayMode", elementAttr: "elementAttr", focusStateEnabled: "focusStateEnabled", height: "height", hint: "hint", hoverStateEnabled: "hoverStateEnabled", infoText: "infoText", itemCount: "itemCount", label: "label", pageIndex: "pageIndex", pageSize: "pageSize", rtlEnabled: "rtlEnabled", showInfo: "showInfo", showNavigationButtons: "showNavigationButtons", showPageSizeSelector: "showPageSizeSelector", tabIndex: "tabIndex", visible: "visible", width: "width" }, outputs: { onContentReady: "onContentReady", onDisposing: "onDisposing", onInitialized: "onInitialized", onOptionChanged: "onOptionChanged", accessKeyChange: "accessKeyChange", activeStateEnabledChange: "activeStateEnabledChange", allowedPageSizesChange: "allowedPageSizesChange", disabledChange: "disabledChange", displayModeChange: "displayModeChange", elementAttrChange: "elementAttrChange", focusStateEnabledChange: "focusStateEnabledChange", heightChange: "heightChange", hintChange: "hintChange", hoverStateEnabledChange: "hoverStateEnabledChange", infoTextChange: "infoTextChange", itemCountChange: "itemCountChange", labelChange: "labelChange", pageIndexChange: "pageIndexChange", pageSizeChange: "pageSizeChange", rtlEnabledChange: "rtlEnabledChange", showInfoChange: "showInfoChange", showNavigationButtonsChange: "showNavigationButtonsChange", showPageSizeSelectorChange: "showPageSizeSelectorChange", tabIndexChange: "tabIndexChange", visibleChange: "visibleChange", widthChange: "widthChange" }, host: { attributes: { "ngSkipHydration": "true" } }, providers: [
DxTemplateHost,
WatcherHelper,
NestedOptionHost,
IterableDifferHelper
], usesInheritance: true, usesOnChanges: true, ngImport: i0, template: '', isInline: true });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxPaginationComponent, decorators: [{
type: Component,
args: [{
selector: 'dx-pagination',
template: '',
host: { ngSkipHydration: 'true' },
providers: [
DxTemplateHost,
WatcherHelper,
NestedOptionHost,
IterableDifferHelper
]
}]
}], ctorParameters: () => [{ type: i0.ElementRef }, { type: i0.NgZone }, { type: i1.DxTemplateHost }, { type: i1.WatcherHelper }, { type: i1.IterableDifferHelper }, { type: i1.NestedOptionHost }, { type: i0.TransferState }, { type: undefined, decorators: [{
type: Inject,
args: [PLATFORM_ID]
}] }], propDecorators: { accessKey: [{
type: Input
}], activeStateEnabled: [{
type: Input
}], allowedPageSizes: [{
type: Input
}], disabled: [{
type: Input
}], displayMode: [{
type: Input
}], elementAttr: [{
type: Input
}], focusStateEnabled: [{
type: Input
}], height: [{
type: Input
}], hint: [{
type: Input
}], hoverStateEnabled: [{
type: Input
}], infoText: [{
type: Input
}], itemCount: [{
type: Input
}], label: [{
type: Input
}], pageIndex: [{
type: Input
}], pageSize: [{
type: Input
}], rtlEnabled: [{
type: Input
}], showInfo: [{
type: Input
}], showNavigationButtons: [{
type: Input
}], showPageSizeSelector: [{
type: Input
}], tabIndex: [{
type: Input
}], visible: [{
type: Input
}], width: [{
type: Input
}], onContentReady: [{
type: Output
}], onDisposing: [{
type: Output
}], onInitialized: [{
type: Output
}], onOptionChanged: [{
type: Output
}], accessKeyChange: [{
type: Output
}], activeStateEnabledChange: [{
type: Output
}], allowedPageSizesChange: [{
type: Output
}], disabledChange: [{
type: Output
}], displayModeChange: [{
type: Output
}], elementAttrChange: [{
type: Output
}], focusStateEnabledChange: [{
type: Output
}], heightChange: [{
type: Output
}], hintChange: [{
type: Output
}], hoverStateEnabledChange: [{
type: Output
}], infoTextChange: [{
type: Output
}], itemCountChange: [{
type: Output
}], labelChange: [{
type: Output
}], pageIndexChange: [{
type: Output
}], pageSizeChange: [{
type: Output
}], rtlEnabledChange: [{
type: Output
}], showInfoChange: [{
type: Output
}], showNavigationButtonsChange: [{
type: Output
}], showPageSizeSelectorChange: [{
type: Output
}], tabIndexChange: [{
type: Output
}], visibleChange: [{
type: Output
}], widthChange: [{
type: Output
}] } });
class DxPaginationModule {
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxPaginationModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
/** @nocollapse */ static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "17.3.12", ngImport: i0, type: DxPaginationModule, declarations: [DxPaginationComponent], imports: [DxIntegrationModule,
DxTemplateModule], exports: [DxPaginationComponent, DxTemplateModule] });
/** @nocollapse */ static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxPaginationModule, imports: [DxIntegrationModule,
DxTemplateModule, DxTemplateModule] });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.3.12", ngImport: i0, type: DxPaginationModule, decorators: [{
type: NgModule,
args: [{
imports: [
DxIntegrationModule,
DxTemplateModule
],
declarations: [
DxPaginationComponent
],
exports: [
DxPaginationComponent,
DxTemplateModule
]
}]
}] });
/**
* Generated bundle index. Do not edit.
*/
export { DxPaginationComponent, DxPaginationModule };
//# sourceMappingURL=devextreme-angular-ui-pagination.mjs.map