@refinitiv-ui/elements 5.12.2 → 6.0.0-next.0

package/lib/pagination/index.d.ts

@@ -1,11 +1,16 @@
 import { JSXInterface } from '../jsx';
 import { BasicElement, PropertyValues, TemplateResult, CSSResultGroup } from '@refinitiv-ui/core';
+import { Ref } from '@refinitiv-ui/core/directives/ref.js';
 import '../button/index.js';
 import '../button-bar/index.js';
 import '../layout/index.js';
 import '../text-field/index.js';
-import '@refinitiv-ui/phrasebook/lib/locale/en/pagination.js';
-import { Translate } from '@refinitiv-ui/translate';
+import '@refinitiv-ui/phrasebook/locale/en/pagination.js';
+import { Translate, TranslateDirectiveResult } from '@refinitiv-ui/translate';
+declare enum Direction {
+    increment = "increment",
+    decrement = "decrement"
+}
 /**
  * Used to control and navigate through multiple pages
  * @fires value-changed - Fired when the `value` property is changed
@@ -53,70 +58,6 @@ export declare class Pagination extends BasicElement {
      * @param value max page
      */
     set max(value: string);
-    /**
-     * Current page
-     * @returns current page
-     * @deprecated
-     * @ignore
-     */
-    get page(): string;
-    /**
-     * Set current page
-     * @param value - Set current page
-     * @deprecated
-     * @ignore
-     */
-    set page(value: string);
-    /**
-     * Number of item per page
-     * @returns number of items per page
-     * @deprecated
-     * @ignore
-     */
-    get pageSize(): string;
-    /**
-     * Set number of item per page
-     * @param value - number of item per page
-     * @deprecated
-     * @ignore
-     */
-    set pageSize(value: string);
-    /**
-     * Number of item per page internal value
-     * @deprecated
-     */
-    private _pageSize;
-    /**
-     * Internal page size
-     * @deprecated
-     * @returns page size
-     */
-    private get internalPageSize();
-    /**
-     * Total items internal value
-     * @deprecated
-     */
-    private _totalItems;
-    /**
-     * Internal total items
-     * @returns total items
-     * @deprecated
-     */
-    private get internalTotalitems();
-    /**
-     * Total items
-     * @returns total items
-     * @deprecated
-     * @ignore
-     */
-    get totalItems(): string;
-    /**
-     * Set total items
-     * @param value total items
-     * @deprecated
-     * @ignore
-     */
-    set totalItems(value: string);
     /**
      * Set state to disable
      */
@@ -127,18 +68,28 @@ export declare class Pagination extends BasicElement {
      */
     private get infinitePaginate();
     /**
-     * Getter for text field as input part
+     * Reference input element
+     */
+    protected inputRef: Ref<HTMLInputElement>;
+    /**
+     * Getter for input element
+     * @returns input element
      */
-    private input;
+    protected get inputElement(): HTMLInputElement | null;
     /**
      * Used for translations
      */
     protected t: Translate;
     /**
-     * Getter for display text in the input
-     * @returns input text
+     * Getter for display page number or text depends on focusing the input
+     * @returns string page number value or translate directive result
+     */
+    protected get inputValue(): string | TranslateDirectiveResult;
+    /**
+     * Get page text format in various translation
+     * @returns translate directive result
      */
-    protected get inputText(): string;
+    protected get inputTextFormat(): TranslateDirectiveResult;
     /**
      * State for check the input focus
      */
@@ -163,6 +114,11 @@ export declare class Pagination extends BasicElement {
      * @override
      */
     protected updated(changedProperties: PropertyValues): void;
+    /**
+     * Select text in input when update element complete
+     * @returns returns a promise void
+     */
+    private selectInput;
     /**
      * Validate page value which returns true when value is valid
      * @param value value
@@ -172,34 +128,25 @@ export declare class Pagination extends BasicElement {
      */
     private validatePage;
     /**
-     * Handles action when Enter and Tab key is press onto the input
-     * @param event Keyboard event
+     * Set page to the pagination
+     * @param value page number
      * @returns {void}
      */
-    private onInputKeyDown;
-    /**
-     * Handles action when input focused change
-     * @param event focus change event
-     * @returns {void}
-     */
-    private onInputFocusedChanged;
-    /**
-     * Update page by using value from the input
-     * @returns {void}
-     */
-    private updatePageInput;
-    /**
-     * Select text in input when update element complete
-     * @returns returns a promise void
-     */
-    private selectInput;
+    private setPage;
     /**
      * Updates page value depending on direction
      * @param direction page value direction
-     * @param event whether the event page-changed should fire
+     * @param withEvent whether the event page-changed should fire
      * @returns {void}
      */
     private updatePage;
+    /**
+     * Update input value. Do not update pagination actual value until Enter key is pressed or blur event is fired
+     * @param value input value
+     * @param direction update from old value
+     * @returns void
+     */
+    protected updateInputValue(value?: number, direction?: Direction | null): void;
     /**
      * Fires event when value change
      * @returns {void}
@@ -245,6 +192,41 @@ export declare class Pagination extends BasicElement {
      * @returns {void}
      */
     private onLastTap;
+    /**
+     * Check pagination has a next page
+     * @param page current page number
+     * @returns true if pagination has a next page
+     */
+    protected hasNextPage(page: number): boolean;
+    /**
+     * Check pagination has a previous page
+     * @param page current page number
+     * @returns true if pagination has a previous page
+     */
+    protected hasPreviousPage(page: number): boolean;
+    /**
+     * Check pagination has a last page
+     * @returns true if pagination has a last page
+     */
+    protected hasLastPage(): boolean;
+    /**
+     * Handles action when input focused change
+     * @param event focus change event
+     * @returns {void}
+     */
+    private onFocusedChanged;
+    /**
+     * Runs on input element `input` event
+     * @param event `input` event
+     * @returns {void}
+     */
+    protected onInputInput(): void;
+    /**
+     * Handles key down event
+     * @param event Key down event object
+     * @returns {void}
+     */
+    private onKeyDown;
     /**
      * A `CSSResultGroup` that will be used
      * to style the host, slotted children
@@ -259,6 +241,7 @@ export declare class Pagination extends BasicElement {
      */
     protected render(): TemplateResult;
 }
+export {};
 
 declare global {
   interface HTMLElementTagNameMap {