@acorex/components 18.5.16 → 18.6.0

package/fesm2022/acorex-components-data-pager.mjs

@@ -41,6 +41,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
             type: Injectable
         }] });
 class AXDataPagerChild extends MXInteractiveComponent {
+    /**
+     *  @ignore
+     */
     constructor() {
         super();
         this._parent = inject(AXDataPagerParentComponent);
@@ -54,6 +57,9 @@ class AXDataPagerChild extends MXInteractiveComponent {
             this.applyParent();
         });
     }
+    /**
+     *  @ignore
+     */
     ngAfterViewInit() {
         this.applyParent();
     }
@@ -64,11 +70,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
             type: Injectable
         }], ctorParameters: () => [] });
 
+/**
+ * Displays formatted and translated information text for a data pager component.
+ *
+ * @category Components
+ */
 class AXDataPagerInfoComponent extends AXDataPagerChild {
     constructor() {
         super(...arguments);
         this.translateService = inject(AXTranslationService);
     }
+    /**
+  *  @ignore
+  */
     applyParent() {
         const info = this._parent.displayInfo;
         if ([info.range, info.range.from, info.totalItems].every((c) => c)) {
@@ -98,17 +112,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
                 type: Input
             }] } });
 
+/**
+ * Provides an input selector for navigating pages in a data pager component.
+ *
+ * @category Components
+ */
 class AXDataPagerInputSelectorComponent extends AXDataPagerChild {
     constructor() {
         super(...arguments);
+        /**
+         *  @ignore
+         */
         this._totalPages = 1;
+        /**
+         *  @ignore
+         */
         this._currentPage = 1;
     }
+    /**
+     *  @ignore
+     */
     applyParent() {
         this._currentPage = this._parent.displayInfo.page;
         this._totalPages = this._parent.displayInfo.totalPages;
         this.cdr.markForCheck();
     }
+    /**
+     *  @ignore
+     */
     _handleValueChanged(e) {
         //TODO: debounceTime
         if (e.isUserInteraction) {
@@ -165,19 +196,36 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
                 }]
         }] });
 
+/**
+ * Provides buttons for navigating to the next and last pages in a data pager component.
+ *
+ * @category Components
+ */
 class AXDataPagerNextButtonsComponent extends AXDataPagerChild {
+    /**
+     *  @ignore
+     */
     ngOnInit() {
         super.ngOnInit;
         this.rtl = AXHtmlUtil.isRtl(this.getHostElement());
     }
+    /**
+     *  @ignore
+     */
     applyParent() {
         this.disabled = this._parent.displayInfo.page == this._parent.displayInfo.totalPages || this._parent.disabled;
     }
+    /**
+     *  @ignore
+     */
     _emitOnLastPageClick(e) {
         if (this._parent.readonly || this._parent.disabled)
             return;
         this._parent.goLastPage();
     }
+    /**
+     *  @ignore
+     */
     _emitOnNextPageClick(e) {
         if (this._parent.readonly || this._parent.disabled)
             return;
@@ -223,6 +271,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
                 }]
         }] });
 
+/**
+ * Component that provides numeric page selection controls for a data pager.
+ *
+ * @category Components
+ */
 class AXDataPagerNumericSelectorComponent extends AXDataPagerChild {
     constructor() {
         super(...arguments);
@@ -230,8 +283,14 @@ class AXDataPagerNumericSelectorComponent extends AXDataPagerChild {
         this._currentPage = 1;
         this._lastPage = 1;
         this._loading = false;
+        /**
+         *  @ignore
+         */
         this._displayCount = 5;
     }
+    /**
+     *  @ignore
+     */
     applyParent() {
         this._currentPage = this._parent.displayInfo.page;
         this._loading = this._parent.isLoading;
@@ -262,6 +321,9 @@ class AXDataPagerNumericSelectorComponent extends AXDataPagerChild {
         }
         this.cdr.detectChanges();
     }
+    /**
+     *  @ignore
+     */
     _handleOnItemClick(e) {
         if (this._parent.readonly || this._parent.disabled)
             return;
@@ -355,19 +417,38 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
                 }]
         }] });
 
+/**
+ * Displays a button to select page sizes for data pagination.
+ *
+ * @category Components
+ */
 class AXDataPagerPageSizesComponent extends AXDataPagerChild {
     constructor() {
         super(...arguments);
+        /**
+         *  @ignore
+         */
         //TODO: AXButtonItems type error
         this._items = [];
     }
+    /**
+     * Gets the list of page sizes available for selection.
+     */
     get sizes() {
         return this._sizes || [5, 10, 20, 50, 100];
     }
+    /**
+     * Sets the list of page sizes available for selection.
+     *
+     * @param value - An array of numbers representing the page sizes to be set.
+     */
     set sizes(v) {
         this._sizes = v;
         this.applyParent();
     }
+    /**
+     *  @ignore
+     */
     applyParent() {
         this._size = this._parent.displayInfo.take;
         this._items = this.sizes.map((s) => ({
@@ -379,6 +460,9 @@ class AXDataPagerPageSizesComponent extends AXDataPagerChild {
         }));
         this.cdr.detectChanges();
     }
+    /**
+     *  @ignore
+     */
     _emitOnItemClick(e) {
         if (this._parent.readonly || this._parent.disabled)
             return;
@@ -429,19 +513,36 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
                 type: Input
             }] } });
 
+/**
+ * Component that provides navigation buttons for going to the previous page and the first page in a data pager.
+ *
+ * @category Components
+ */
 class AXDataPagerPrevButtonsComponent extends AXDataPagerChild {
+    /**
+     *  @ignore
+     */
     ngOnInit() {
         super.ngOnInit;
         this.rtl = AXHtmlUtil.isRtl(this.getHostElement());
     }
+    /**
+     *  @ignore
+     */
     applyParent() {
         this.disabled = this._parent.displayInfo.page == 1 || this._parent.disabled;
     }
+    /**
+     *  @ignore
+     */
     _emitOnFirstPageClick(e) {
         if (this._parent.readonly || this._parent.disabled)
             return;
         this._parent.goFirstPage();
     }
+    /**
+     *  @ignore
+     */
     _emitOnPrevPageClick(e) {
         if (this._parent.readonly || this._parent.disabled)
             return;
@@ -487,16 +588,38 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.2", ngImpor
                 }]
         }] });
 
+/**
+ * Component for managing and displaying data pagination controls.
+ *
+ * @category Components
+ */
 class AXDataPagerComponent extends MXValueComponent {
+    /**
+     * Indicates whether the component is currently loading.
+     *
+     */
     get isLoading() {
         return this._isLoading();
     }
+    /**
+     * Sets the loading state of the component.
+     *
+     * @param v - The loading state to be set.
+     */
     set isLoading(v) {
         this._isLoading.set(v);
     }
+    /**
+     * Gets the number of items per page in the data pager.
+     */
     get size() {
         return this._size || 10;
     }
+    /**
+     * Sets the number of items per page and updates the data pager accordingly.
+     *
+     * @param {number} v - The new number of items per page.
+     */
     set size(v) {
         if (v != this._size) {
             const prevSize = this._size;
@@ -509,9 +632,18 @@ class AXDataPagerComponent extends MXValueComponent {
             this._emitChangedEvent(prevSize != null ? true : false);
         }
     }
+    /**
+     * Gets the total number of items.
+     */
     get total() {
         return this._total;
     }
+    /**
+     * Sets the total number of items and triggers an update event if the value changes.
+     *
+     * @param v - The total number of items to set.
+     *                     If the value is non-positive, it defaults to 0.
+     */
     set total(v) {
         const t = v && v > 0 ? v : 0;
         if (t != this._total) {
@@ -519,15 +651,31 @@ class AXDataPagerComponent extends MXValueComponent {
             this._emitChangedEvent();
         }
     }
+    /**
+     * Gets the total number of pages.
+     */
     get totalPages() {
         return this._totalPages;
     }
+    /**
+     * Sets the total number of pages.
+     *
+     * @param value - The total number of pages to set.
+     */
     set totalPages(value) {
         this._totalPages = value;
     }
+    /**
+     * Gets the current display mode of the data pager.
+     */
     get displayMode() {
         return this._displayMode;
     }
+    /**
+     * Sets the display mode of the data pager and emits a change event.
+     *
+     * @param v - The new display mode to set, of type `AXDataPagerMode`.
+     */
     set displayMode(v) {
         this.setOption({
             name: 'displayMode',
@@ -537,15 +685,43 @@ class AXDataPagerComponent extends MXValueComponent {
             },
         });
     }
+    /**
+     *  @ignore
+     */
     constructor(_parent) {
         super();
         this._parent = _parent;
+        /**
+         *  @ignore
+         */
         this._isLoading = signal(false);
+        /**
+         *  @ignore
+         */
         this._size = null;
+        /**
+         *  @ignore
+         */
         this._total = 0;
+        /**
+         *  @ignore
+         */
         this._totalPages = 0;
+        /**
+         * Emitted when the display mode changes.
+         * @event
+         * An event containing the new display mode.
+         */
         this.displayModeChange = new EventEmitter();
+        /**
+         *  @ignore
+         */
         this._displayMode = 'full';
+        /**
+         * Emitted when the data pager's state changes.
+         * @event
+         * An event containing details about the change.
+         */
         this.onChanged = new EventEmitter();
         //
         if (this._parent) {
@@ -558,12 +734,21 @@ class AXDataPagerComponent extends MXValueComponent {
             this.total = this._parent.totalCount;
         }
     }
+    /**
+     *  @ignore
+     */
     ngAfterViewInit() {
         this._emitChangedEvent();
     }
+    /**
+     *  @ignore
+     */
     internalValueChanged(value) {
         this._emitChangedEvent(true);
     }
+    /**
+     *  @ignore
+     */
     internalGetValue(value) {
         if (!isNumber(value) || !value || this.totalPages == 0)
             return 1;
@@ -584,6 +769,9 @@ class AXDataPagerComponent extends MXValueComponent {
         };
         return result;
     }
+    /**
+     *  @ignore
+     */
     _emitChangedEvent(u = false) {
         this.totalPages = Math.ceil(this._total / this.size);
         //
@@ -601,18 +789,39 @@ class AXDataPagerComponent extends MXValueComponent {
             this.cdr.markForCheck();
         }
     }
+    /**
+     * Navigates to the next page, or to the last page if on the final page.
+     * @ignore
+     */
     goNextPage() {
         this.goToPage(Math.min(this.value + 1, this.totalPages));
     }
+    /**
+     * Navigates to the last page.
+     * @ignore
+     */
     goLastPage() {
         this.goToPage(this.totalPages);
     }
+    /**
+     * Navigates to the first page.
+     * @ignore
+     */
     goFirstPage() {
         this.goToPage(1);
     }
+    /**
+     * Navigates to the previous page, or to the first page if on the initial page.
+     * @ignore
+     */
     goPrevPage() {
         this.goToPage(Math.max(this.value - 1, 1));
     }
+    /**
+     * Navigates to a specified page.
+     * @param page - The page number to navigate to.
+     * @ignore
+     */
     goToPage(page) {
         if (page != this.value) {
             this.commitValue(page, true);