@danxbot/ui 20.10.0 → 20.12.0

package/dist/types/lib/paged-window/use-paged-window.d.ts

@@ -1,25 +1,26 @@
-import { type PagedWindowOptions, type PagedWindowSnapshot } from "./store";
+import { type PagedWindowMode, type PagedWindowOptions, type PagedWindowSnapshot } from "./store";
 export interface UsePagedWindowOptions<T> extends PagedWindowOptions<T> {
     /**
      * Names WHAT is being listed: the filter, the sort, the time range. When it
      * changes the window forgets every page, returns to the first and the list
-     * scrolls back to the top. A change in `loadPage`'s identity alone does not:
+     * scrolls back to the top. A change in a loader's identity alone does not:
      * a loader closing over fresh state must not throw away what is held.
      */
     queryKey: string;
     /**
-     * Off, nothing is held or requested (a hidden lane). Back on, the window
-     * loads again.
-     * @default true
+     * `"count"` loads no cards, only the list's length (through `loadCount`), and
+     * keeps it live: a hidden lane that still needs a true badge. Back to
+     * `"pages"`, the window loads again.
+     * @default "pages"
      */
-    enabled?: boolean;
+    mode?: PagedWindowMode;
 }
 export interface PagedWindow<T> extends PagedWindowSnapshot<T> {
     /** The viewer moved to this page. `PagedWindowList` reports it; a custom view may too. */
     setAnchorPage: (page: number) => void;
     /** Re-read one held page in place — a card on it changed. */
     invalidatePage: (page: number) => void;
-    /** Re-read every held page in place — a card was created, moved or removed. */
+    /** Re-read every held page in place — a card was created, moved or removed. In `count` mode, re-ask the length. */
     invalidateAll: () => void;
     /**
      * While true the window neither loads nor drops pages. `PagedWindowList`
@@ -37,4 +38,4 @@ export interface PagedWindow<T> extends PagedWindowSnapshot<T> {
  * means every held page is cut differently, which is a different list — give it
  * a new `queryKey` and a new mount instead. It throws rather than guessing.
  */
-export declare function usePagedWindow<T>({ pageSize, windowPages, loadPage, queryKey, enabled, }: UsePagedWindowOptions<T>): PagedWindow<T>;
+export declare function usePagedWindow<T>({ pageSize, windowPages, loadPage, loadCount, queryKey, mode, }: UsePagedWindowOptions<T>): PagedWindow<T>;

package/dist/types/lib/paged-window/use-scroll-root.d.ts

@@ -0,0 +1,18 @@
+/** The element a list scrolls in: `el` is null when the page itself scrolls (the viewport). */
+export interface ScrollRoot {
+    el: HTMLElement | null;
+}
+/**
+ * Finds the box a list scrolls in, once the list is in the DOM. DX-4540.
+ *
+ * Returns a ref callback for the list's root and the root it resolved (null
+ * until mounted). The list's OWN element counts: a list whose class sets
+ * `overflow-y-auto` is its own scroller, and one dropped into a board lane
+ * finds the lane's container above it. Resolved on mount only — a list does
+ * not change scroller during its life, and re-walking on every render would
+ * make the IntersectionObserver rooted at it be torn down and rebuilt.
+ */
+export declare function useScrollRoot(): {
+    ref: (el: HTMLElement | null) => void;
+    scroller: ScrollRoot | null;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danxbot/ui",
-  "version": "20.10.0",
+  "version": "20.12.0",
   "type": "module",
   "description": "Danxbot — a domain-agnostic React design system with motion as a first-class primitive.",
   "license": "MIT",