@rebasepro/ui 0.22.0 → 0.24.0

package/dist/util/keys.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Whether a key event has already been handled by something above you — the
+ * one question every global key handler (a `keydown` listener on `window` or
+ * `document`) must ask before acting.
+ *
+ * The rule: **a handler that acts on a key calls `event.preventDefault()`;
+ * a global handler that finds the event already handled does nothing.** Every
+ * kit overlay follows it for free — `Dialog`, `Sheet`, `Popover`, `Menu`,
+ * `Select`, `MultiSelect`, `Tooltip` are Radix layers, and a Radix layer calls
+ * `preventDefault()` on the Escape it consumes to close itself. So Escape
+ * pressed in an open dropdown closes the dropdown, and the record panel's
+ * Escape handler underneath sees it handled and leaves the record open.
+ *
+ * Two conditions make it hold:
+ *
+ *  - **Listen in the bubble phase.** A Radix layer listens on `document` in
+ *    the capture phase, so it has run before any bubble listener — on the
+ *    target, on `document` or on `window` — whatever order they were added in.
+ *    A capture listener added before the layer opened runs *before* it and
+ *    cannot see its claim. Only a layer of your own, one that sits above
+ *    everything else while it is open, belongs in the capture phase, and it
+ *    must call `preventDefault()` when it acts.
+ *  - **Do not ask the DOM instead.** `document.querySelector('[role="dialog"]')`
+ *    misses every layer that is not a dialog (a menu is `role="menu"`, a select
+ *    list `role="listbox"`), and the list of roles is never finished.
+ *
+ * An IME composition counts as handled too: Escape while composing Japanese or
+ * Chinese text cancels the composition, and must not close a panel.
+ */
+export declare function isKeyHandled(event: KeyboardEvent): boolean;

package/dist/views/CardView.d.ts

@@ -1,5 +1,6 @@
 import React from "react";
 import { CollectionSize } from "./ListView.js";
+import { type ViewScrollEvent } from "./useScrollParentRestoration.js";
 export type CardViewProps<T> = {
     data: T[];
     dataLoading?: boolean;
@@ -14,11 +15,7 @@ export type CardViewProps<T> = {
     highlightedIds?: Set<string | number>;
     selectionEnabled?: boolean;
     onSelectionChange?: (item: T, selected: boolean) => void;
-    onScroll?: (props: {
-        scrollDirection: "forward" | "backward";
-        scrollOffset: number;
-        scrollUpdateWasRequested: boolean;
-    }) => void;
+    onScroll?: (props: ViewScrollEvent) => void;
     initialScroll?: number;
     size?: CollectionSize;
     renderCard: (item: T, extra: {

package/dist/views/ListView.d.ts

@@ -1,4 +1,5 @@
 import React from "react";
+import { type ViewScrollEvent } from "./useScrollParentRestoration.js";
 export type CollectionSize = "xs" | "s" | "m" | "l" | "xl";
 export type ListViewColumnDef<T> = {
     key: string;
@@ -23,6 +24,13 @@ export type ListViewProps<T> = {
     selectionEnabled?: boolean;
     onSelectionChange?: (item: T, selected: boolean) => void;
     emptyComponent?: React.ReactNode;
+    /**
+     * Called with the scroll parent's offset as it scrolls, and restored from
+     * `initialScroll` on mount — the list does not scroll itself, the page
+     * around it does.
+     */
+    onScroll?: (props: ViewScrollEvent) => void;
+    initialScroll?: number;
     size?: CollectionSize;
     selectedEntityId?: string | number;
     /**
@@ -43,4 +51,4 @@ export type ListViewProps<T> = {
         onSelectionChange: (selected: boolean) => void;
     }) => React.ReactNode;
 };
-export declare function ListView<T>({ data, dataLoading, noMoreToLoad, dataLoadingError, itemCount, setItemCount, pageSize, paginationEnabled, onItemClick, selectedIds, highlightedIds, selectionEnabled, onSelectionChange, emptyComponent, size, selectedEntityId, header, renderRow }: ListViewProps<T>): React.JSX.Element;
+export declare function ListView<T>({ data, dataLoading, noMoreToLoad, dataLoadingError, itemCount, setItemCount, pageSize, paginationEnabled, onItemClick, selectedIds, highlightedIds, selectionEnabled, onSelectionChange, emptyComponent, onScroll, initialScroll, size, selectedEntityId, header, renderRow }: ListViewProps<T>): React.JSX.Element;

package/dist/views/useScrollParentRestoration.d.ts

@@ -0,0 +1,26 @@
+import React from "react";
+export type ViewScrollEvent = {
+    scrollDirection: "forward" | "backward";
+    scrollOffset: number;
+    scrollUpdateWasRequested: boolean;
+};
+/**
+ * The nearest ancestor that scrolls vertically. The list and card views do not
+ * scroll themselves: the page around them does, so that is the element whose
+ * offset is worth keeping.
+ */
+export declare function getScrollParent(element: HTMLElement | null): HTMLElement | null;
+/**
+ * Report the scroll parent's offset through `onScroll`, and put it back at
+ * `initialScroll` once there are rows to scroll over.
+ *
+ * Opening a record full screen unmounts the collection view, so coming back
+ * mounts a fresh one. The caller keeps the offset (and the rows it was over)
+ * outside the component; this is what hands it over and applies it again.
+ */
+export declare function useScrollParentRestoration({ containerRef, initialScroll, onScroll, dataLength }: {
+    containerRef: React.RefObject<HTMLElement | null>;
+    initialScroll?: number;
+    onScroll?: (props: ViewScrollEvent) => void;
+    dataLength: number;
+}): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebasepro/ui",
-  "version": "0.22.0",
+  "version": "0.24.0",
   "description": "Rebase design system — React components and design tokens built on Radix UI, Tailwind CSS and lucide-react",
   "keywords": [
     "rebase",