@astryxdesign/core 0.7.8-canary.ffd29c5 → 0.7.8

package/dist/keyboard/useMobileKeyboard.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @file useMobileKeyboard.ts
+ * @input A target element and its scroll area, the keyboard module's reports
+ *   and focus claim, and the layout guide
+ * @output useMobileKeyboard, which keeps a focused field in the target above
+ *   the on-screen keyboard and returns the inset and a dismiss
+ * @position Keyboard module, internal to core. BottomSheet passes its panel.
+ *
+ * SYNC: When modified, update /packages/core/src/keyboard/README.md
+ */
+import { type RefObject } from 'react';
+/** How a target keeps a focused field above the on-screen keyboard. */
+export interface MobileKeyboardOptions {
+    /**
+     * How the target moves the field: `'ride'` reveals it with the scroller
+     * and rides the scroller's content on the keyboard's slide.
+     */
+    move: 'ride';
+    /**
+     * Reserves the keyboard's inset at the end of the target's scroll area,
+     * the first element inside it that `useScrollableArea` marks with
+     * `data-scroll-axis`.
+     */
+    inset?: boolean;
+    /** The gap kept between the focused field and the keyboard, CSS px. */
+    offset: number;
+    /** Whether the target follows the keyboard at all. */
+    isEnabled: boolean;
+    /** Whether the target is at its full height, where it reveals fields. */
+    isExpanded: boolean;
+    /** Whether the target is open. Focus that leaves for nothing parks on it. */
+    isOpen: boolean;
+    /** Whether the page's own scroll is locked under the target. */
+    isPageScrollLocked: boolean;
+}
+/** What useMobileKeyboard returns. */
+export interface MobileKeyboard {
+    /** The inset the target lays out at its scroller's content end, CSS px. */
+    readonly inset: number;
+    /**
+     * Dismisses the keyboard, keeping the inset while the keyboard goes. The
+     * focused field blurs, or `focusTarget` takes focus.
+     */
+    readonly dismiss: (focusTarget?: HTMLElement) => void;
+}
+/** Forgets every window's recorded reveal, for tests. */
+export declare function __resetRevealsAtReportForTest(): void;
+/**
+ * Keeps a focused field in `targetRef`'s element above the on-screen
+ * keyboard (see README.md). A sheet passes its panel, and the hook reserves
+ * the inset in the panel's scroll area. Returns the inset the keyboard takes
+ * at the end of that area's content, CSS px, or 0 without a keyboard, and a
+ * dismiss.
+ *
+ * @example
+ * ```
+ * const keyboard = useMobileKeyboard(panelRef, {move: 'ride', inset: true, offset: 48, isEnabled, isExpanded, isOpen, isPageScrollLocked});
+ * ```
+ */
+export declare function useMobileKeyboard(targetRef: RefObject<HTMLElement | null>, { inset: reservesInset, offset, isEnabled, isExpanded, isOpen, isPageScrollLocked, }: MobileKeyboardOptions): MobileKeyboard;
+//# sourceMappingURL=useMobileKeyboard.d.ts.map

package/dist/keyboard/useMobileKeyboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMobileKeyboard.d.ts","sourceRoot":"","sources":["../../src/keyboard/useMobileKeyboard.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AAEH,OAAO,EAA2C,KAAK,SAAS,EAAC,MAAM,OAAO,CAAC;AA+B/E,uEAAuE;AACvE,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,uEAAuE;IACvE,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,SAAS,EAAE,OAAO,CAAC;IACnB,yEAAyE;IACzE,UAAU,EAAE,OAAO,CAAC;IACpB,6EAA6E;IAC7E,MAAM,EAAE,OAAO,CAAC;IAChB,gEAAgE;IAChE,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,sCAAsC;AACtC,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,EAAE,WAAW,KAAK,IAAI,CAAC;CACvD;AAmBD,yDAAyD;AACzD,wBAAgB,6BAA6B,IAAI,IAAI,CAEpD;AAkBD;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,EACxC,EACE,KAAK,EAAE,aAAqB,EAC5B,MAAM,EACN,SAAS,EACT,UAAU,EACV,MAAM,EACN,kBAAkB,GACnB,EAAE,qBAAqB,GACvB,cAAc,CAmtBhB"}