npm - @multiplatform.one/forms - Versions diffs - 7.41.0 → 7.42.0 - Mend

@@ -0,0 +1,48 @@
+/**
+ * The return-key chain (FZ-7718): on a phone, Return in a text field moves to
+ * the next field on screen and submits from the last one.
+ *
+ * Fields register with the nearest scope (a Form, a KeyboardAvoidingWrapper,
+ * or the app-wide default). Order is where the fields sit on screen, measured
+ * rather than mounted, so a field revealed later still slots into its row.
+ */
+import { type ReactNode } from "react";
+export interface ChainBox {
+    id: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface ChainEntry {
+    id: string;
+    focus: () => void;
+    measure: (done: (box: ChainBox | undefined) => void) => void;
+}
+/** Top-to-bottom, then left-to-right for fields that share a row. */
+export declare function readingOrder(boxes: ChainBox[]): string[];
+export declare class KeyboardChain {
+    private entries;
+    private order;
+    private listeners;
+    private pending;
+    subscribe: (listener: () => void) => () => void;
+    register(entry: ChainEntry): () => void;
+    /** A field that has not been measured yet reads as last, so it never claims "next" falsely. */
+    isLast(id: string): boolean;
+    invalidate(): void;
+    /**
+     * Focus the field after `id`, or run onLast from the last one. Uses the
+     * order measured at layout, and measures first only for a field it has not
+     * placed yet.
+     */
+    advance(id: string, onLast: () => void): void;
+    private step;
+    private refresh;
+}
+export declare const KeyboardChainContext: import("react").Context<KeyboardChain>;
+/** Starts a fresh return-key chain for the fields inside it. */
+export declare function KeyboardChainScope({ children }: {
+    children?: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=chain.d.ts.map

@@ -0,0 +1,6 @@
+export { KeyboardChain, KeyboardChainContext, KeyboardChainScope, readingOrder } from "./chain";
+export type { ChainBox, ChainEntry } from "./chain";
+export { KeyboardDoneBar } from "./KeyboardDoneBar";
+export { useKeyboardChain } from "./useKeyboardChain";
+export type { KeyboardChainBinding, KeyboardChainOptions, KeyboardDoneBarProps } from "./types";
+//# sourceMappingURL=index.d.ts.map

@@ -0,0 +1,19 @@
+import type { ReactNode, RefObject } from "react";
+export interface KeyboardChainOptions {
+    inputRef: RefObject<unknown>;
+    /** Off for disabled and read-only fields. */
+    enabled?: boolean;
+    /** Multiline fields keep Return for newlines and only get the Done bar. */
+    multiline?: boolean;
+    /** Runs when Return is pressed in the last field (a form's submit). */
+    onSubmitLast?: () => void;
+    onSubmitEditing?: (...args: any[]) => void;
+}
+export interface KeyboardChainBinding {
+    inputProps: Record<string, unknown>;
+    accessory: ReactNode;
+}
+export interface KeyboardDoneBarProps {
+    nativeID: string;
+}
+//# sourceMappingURL=types.d.ts.map

@@ -0,0 +1,4 @@
+import type { KeyboardChainBinding, KeyboardChainOptions } from "./types";
+/** Web keeps the browser's own Enter and Tab behaviour. */
+export declare function useKeyboardChain(_options: KeyboardChainOptions): KeyboardChainBinding;
+//# sourceMappingURL=useKeyboardChain.d.ts.map

@@ -0,0 +1,3 @@
+import type { KeyboardChainBinding, KeyboardChainOptions } from "./types";
+export declare function useKeyboardChain({ inputRef, enabled, multiline, onSubmitLast, onSubmitEditing, }: KeyboardChainOptions): KeyboardChainBinding;
+//# sourceMappingURL=useKeyboardChain.native.d.ts.map

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/keyboard/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAChG,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC"}

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"useKeyboardChain.d.ts","sourceRoot":"","sources":["../../src/keyboard/useKeyboardChain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE1E,2DAA2D;AAC3D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,oBAAoB,CAErF"}

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"useKeyboardChain.native.d.ts","sourceRoot":"","sources":["../../src/keyboard/useKeyboardChain.native.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAO1E,wBAAgB,gBAAgB,CAAC,EAC/B,QAAQ,EACR,OAAc,EACd,SAAS,EACT,YAAY,EACZ,eAAe,GAChB,EAAE,oBAAoB,GAAG,oBAAoB,CA6D7C"}

@multiplatform.one/forms 7.41.0 → 7.42.0