stimeo-ui 0.16.0 → 0.18.0

package/dist/controllers/pagination_controller.d.ts

@@ -25,11 +25,20 @@ import { Controller } from '@hotwired/stimulus';
  * `prev`/`next` must be real `<button>` elements: the boundary state is applied
  * through the native `disabled` property, which a `<div>` or `<a>` does not honor.
  *
- * `change` dispatches `{ page: number, total: number, previous: number }`, and
- * `reconcile` dispatches the same `{ page: number, total: number, previous: number }`
+ * `change` dispatches `{ page: number, total: number, previous: number, reason: StateReason }`;
+ * `reconcile` dispatches `{ page: number, total: number, previous: number }`
  * — `previous` is the page shown before — when a change the page made moves the
  * current page.
  *
+ * User `change` reports compare the resulting state with the last published
+ * state. A pending page write handled in the same script joins that confirmation;
+ * a browser-delivered listener may settle it first as `reconcile`. Confirming
+ * the last published state reports nothing.
+ *
+ * A synchronous subscriber that confirms another state replaces reports still
+ * pending for the outer confirmation. Reading state or confirming it unchanged
+ * does not replace them. An event already being dispatched cannot be recalled.
+ *
  * @remarks
  * Behavior only — each control is in the natural Tab order (no roving). When a
  * boundary disables the button that currently has focus, focus is moved first so
@@ -52,8 +61,9 @@ import { Controller } from '@hotwired/stimulus';
  *   Once connected, a batch that moves the current page away from the one shown
  *   dispatches `stimeo--pagination:reconcile` once; the initial render reports
  *   nothing.
- * - Every navigation dispatches `stimeo--pagination:change`, whose `detail.total`
- *   is the same clamped total the boundary state is derived from.
+ * - A navigation that moves the published page dispatches
+ *   `stimeo--pagination:change`, whose `detail.total` is the same clamped total
+ *   the boundary state is derived from.
  *
  * The boundary `disabled` is **owned**: the controller marks what it disabled
  * with `data-stimeo--pagination-boundary-disabled` and releases only that. A
@@ -76,11 +86,21 @@ declare class PaginationController extends Controller<HTMLElement> {
             default: number;
         };
     };
+    static valueConstraints: {
+        page: {
+            readonly finite: true;
+        };
+        total: {
+            readonly finite: true;
+        };
+    };
     static actions: readonly ["next", "prev", "select"];
     static events: readonly ["change", "reconcile"];
     readonly pageTargets: HTMLElement[];
     readonly prevTarget: HTMLButtonElement;
+    readonly prevTargets: HTMLButtonElement[];
     readonly nextTarget: HTMLButtonElement;
+    readonly nextTargets: HTMLButtonElement[];
     readonly hasPrevTarget: boolean;
     readonly hasNextTarget: boolean;
     pageValue: number;
@@ -97,14 +117,24 @@ declare class PaginationController extends Controller<HTMLElement> {
     pageTargetConnected(): void;
     /** Syncs a `prev` button appended/replaced at runtime. */
     prevTargetConnected(): void;
+    /**
+     * Gives a `prev` that is no longer a target back the boundary `disabled` this
+     * controller set, and brings the one that stays to the current boundary state.
+     */
+    prevTargetDisconnected(button: HTMLButtonElement): void;
     /** Syncs a `next` button appended/replaced at runtime. */
     nextTargetConnected(): void;
+    /**
+     * Gives a `next` that is no longer a target back the boundary `disabled` this
+     * controller set, and brings the one that stays to the current boundary state.
+     */
+    nextTargetDisconnected(button: HTMLButtonElement): void;
     /** Makes the clicked page button (its `data-page`) current. */
-    select(event: Event): void;
+    select(source: Event | HTMLElement): void;
     /** Steps to the previous page. */
-    prev(): void;
+    prev(event?: Event): void;
     /** Steps to the next page. */
-    next(): void;
+    next(event?: Event): void;
 }
 
 export { PaginationController };