@lumen-stack/react 0.9.3 → 0.10.0

package/dist/index.d.cts

@@ -2,7 +2,7 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import { ReactNode, RefObject } from 'react';
 import { LumenUser, AmplitudeIdentity, ScreenshotCaptureOptions, LumenRecordProvider, LumenClient, SubmitPayload, SubmitOptions, SubmitResult, CaptureResult } from '@lumen-stack/core';
-export { CaptureMetadata, CaptureMethod, CapturePlatform, CaptureResult, FeedbackCategory, LUMEN_SHAKE_MESSAGE, LumenClient, LumenError, LumenRecordProvider, LumenRecordingResult, LumenRecordingSession, LumenUser, NativeCaptureProviderOptions, NativeCaptureRequest, NativeCaptureResponse, ScreenshotCaptureMode, ScreenshotCaptureOptions, ScreenshotCaptureProvider, ShakeMessage, SubmitPayload, SubmitResult, VideoRecorderHandle, VideoRecording, createNativeCaptureProvider, isLumenEventTarget } from '@lumen-stack/core';
+export { CaptureMetadata, CaptureMethod, CapturePlatform, CaptureResult, FeedbackCategory, LUMEN_KEYBOARD_CSS_VAR, LUMEN_KEYBOARD_EVENT, LUMEN_SHAKE_MESSAGE, LumenClient, LumenError, LumenRecordProvider, LumenRecordingResult, LumenRecordingSession, LumenUser, NativeCaptureProviderOptions, NativeCaptureRequest, NativeCaptureResponse, ScreenshotCaptureMode, ScreenshotCaptureOptions, ScreenshotCaptureProvider, ShakeMessage, SubmitPayload, SubmitResult, VideoRecorderHandle, VideoRecording, createNativeCaptureProvider, isLumenEventTarget, isolateLumenEvents, readLumenKeyboardInset, setLumenKeyboardInset } from '@lumen-stack/core';
 
 type LumenTriggerPlacement = "br" | "bl" | "tr" | "tl";
 interface FloatingTriggerConfig {
@@ -15,7 +15,15 @@ interface FloatingTriggerConfig {
     safeArea?: boolean;
     /** Selectors to clear; pass `false` to disable auto-detect entirely. */
     avoid?: string | string[] | false;
-    hideOnKeyboard?: boolean;
+    /**
+     * What the floating trigger does when the soft keyboard opens:
+     * - `"auto"` (default) — lift the trigger above the keyboard when its height
+     *   is known (incl. WebView hosts that inject it), else hide it.
+     * - `"lift"` — always lift by the keyboard inset.
+     * - `"hide"` — fade out (the pre-0.10 behavior).
+     * Booleans are accepted for back-compat: `true` → `"hide"`, `false` → off.
+     */
+    hideOnKeyboard?: boolean | "auto" | "lift" | "hide";
     zIndex?: number;
     label?: string;
     icon?: ReactNode;
@@ -157,9 +165,30 @@ interface LumenProviderProps {
      * Runs after `beforeOpen` and before the pre-open screenshot.
      */
     onTriggerActivate?: (event?: Event) => void | Promise<void>;
+    /**
+     * Stop the trigger's own pointer/click events from bubbling into host
+     * outside-click handlers (Silk/Vaul/Radix), so a host bottom sheet/dialog
+     * stays open when the user taps the Lumen trigger. Default `true`. Hosts that
+     * listen in the capture phase should still guard with `isLumenEventTarget`.
+     */
+    isolateEvents?: boolean;
+    /**
+     * Soft-keyboard height (CSS px) for WebView hosts where
+     * `window.visualViewport` does NOT shrink (iOS WKWebView). When set, the
+     * trigger lifts above the keyboard and the modal keeps its focused input
+     * visible. Prefer `setLumenKeyboardInset()` from injected JS for a native
+     * shell; this prop is for same-process hosts that already track the height.
+     */
+    keyboardInset?: number;
+    /**
+     * Hide the floating/notch trigger while a host overlay owns the screen (the
+     * host's own modal, a full-screen route, etc.). The sheet stays openable
+     * programmatically via `useLumen().open()`. Default `false`.
+     */
+    suppressTrigger?: boolean;
     children: React.ReactNode;
 }
-declare function LumenProvider({ apiKey, apiUrl, user, amplitude, floatingButton, trigger, hideOn, theme, portalTarget, capture, record, shakeToOpen, onOpenChange, beforeOpen, onTriggerActivate, children, }: LumenProviderProps): react_jsx_runtime.JSX.Element;
+declare function LumenProvider({ apiKey, apiUrl, user, amplitude, floatingButton, trigger, hideOn, theme, portalTarget, capture, record, shakeToOpen, onOpenChange, beforeOpen, onTriggerActivate, isolateEvents, keyboardInset, suppressTrigger, children, }: LumenProviderProps): react_jsx_runtime.JSX.Element;
 
 interface FeedbackButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
     variant?: "default" | "ghost" | "outline";
@@ -240,6 +269,10 @@ interface LumenContextValue {
     initialCaptureError: Error | null;
     /** True while the trigger has been activated and the pre-open capture is running. */
     isOpening: boolean;
+    /** Whether Lumen stops its own pointer/click events from leaking into host overlays. */
+    isolateEvents: boolean;
+    /** Soft-keyboard inset override (px) from the host, when provided. */
+    keyboardInset: number | undefined;
     openCapture: (event?: Event) => void;
     closeCapture: () => void;
     isSubmitting: boolean;
@@ -247,4 +280,21 @@ interface LumenContextValue {
 }
 declare function useLumen(): LumenContextValue;
 
-export { CaptureModal, FeedbackButton, type FeedbackButtonProps, type FloatingTriggerConfig, type HeadlessTriggerConfig, type InlineTriggerConfig, type LumenContextValue, LumenProvider, type LumenProviderProps, type LumenTheme, type LumenTrigger, type LumenTriggerPlacement, type NotchEdge, type NotchTriggerConfig, useLumen };
+interface KeyboardInsetState {
+    /** True when the soft keyboard is judged to be covering the viewport. */
+    open: boolean;
+    /** Keyboard height (CSS px) to lift UI by. 0 when closed/unknown. */
+    inset: number;
+}
+/**
+ * Keyboard-awareness that works on web AND inside an iOS WKWebView.
+ *
+ * `window.visualViewport` does NOT shrink for the keyboard in a WKWebView, so a
+ * viewport-only approach silently fails there. This hook merges three sources
+ * (see {@link decideKeyboardInset}) and returns both whether the keyboard is
+ * open and how tall it is, so callers can lift the trigger / modal input above
+ * it rather than just hiding them.
+ */
+declare function useKeyboardInset(enabled: boolean, override?: number): KeyboardInsetState;
+
+export { CaptureModal, FeedbackButton, type FeedbackButtonProps, type FloatingTriggerConfig, type HeadlessTriggerConfig, type InlineTriggerConfig, type KeyboardInsetState, type LumenContextValue, LumenProvider, type LumenProviderProps, type LumenTheme, type LumenTrigger, type LumenTriggerPlacement, type NotchEdge, type NotchTriggerConfig, useKeyboardInset, useLumen };

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import { ReactNode, RefObject } from 'react';
 import { LumenUser, AmplitudeIdentity, ScreenshotCaptureOptions, LumenRecordProvider, LumenClient, SubmitPayload, SubmitOptions, SubmitResult, CaptureResult } from '@lumen-stack/core';
-export { CaptureMetadata, CaptureMethod, CapturePlatform, CaptureResult, FeedbackCategory, LUMEN_SHAKE_MESSAGE, LumenClient, LumenError, LumenRecordProvider, LumenRecordingResult, LumenRecordingSession, LumenUser, NativeCaptureProviderOptions, NativeCaptureRequest, NativeCaptureResponse, ScreenshotCaptureMode, ScreenshotCaptureOptions, ScreenshotCaptureProvider, ShakeMessage, SubmitPayload, SubmitResult, VideoRecorderHandle, VideoRecording, createNativeCaptureProvider, isLumenEventTarget } from '@lumen-stack/core';
+export { CaptureMetadata, CaptureMethod, CapturePlatform, CaptureResult, FeedbackCategory, LUMEN_KEYBOARD_CSS_VAR, LUMEN_KEYBOARD_EVENT, LUMEN_SHAKE_MESSAGE, LumenClient, LumenError, LumenRecordProvider, LumenRecordingResult, LumenRecordingSession, LumenUser, NativeCaptureProviderOptions, NativeCaptureRequest, NativeCaptureResponse, ScreenshotCaptureMode, ScreenshotCaptureOptions, ScreenshotCaptureProvider, ShakeMessage, SubmitPayload, SubmitResult, VideoRecorderHandle, VideoRecording, createNativeCaptureProvider, isLumenEventTarget, isolateLumenEvents, readLumenKeyboardInset, setLumenKeyboardInset } from '@lumen-stack/core';
 
 type LumenTriggerPlacement = "br" | "bl" | "tr" | "tl";
 interface FloatingTriggerConfig {
@@ -15,7 +15,15 @@ interface FloatingTriggerConfig {
     safeArea?: boolean;
     /** Selectors to clear; pass `false` to disable auto-detect entirely. */
     avoid?: string | string[] | false;
-    hideOnKeyboard?: boolean;
+    /**
+     * What the floating trigger does when the soft keyboard opens:
+     * - `"auto"` (default) — lift the trigger above the keyboard when its height
+     *   is known (incl. WebView hosts that inject it), else hide it.
+     * - `"lift"` — always lift by the keyboard inset.
+     * - `"hide"` — fade out (the pre-0.10 behavior).
+     * Booleans are accepted for back-compat: `true` → `"hide"`, `false` → off.
+     */
+    hideOnKeyboard?: boolean | "auto" | "lift" | "hide";
     zIndex?: number;
     label?: string;
     icon?: ReactNode;
@@ -157,9 +165,30 @@ interface LumenProviderProps {
      * Runs after `beforeOpen` and before the pre-open screenshot.
      */
     onTriggerActivate?: (event?: Event) => void | Promise<void>;
+    /**
+     * Stop the trigger's own pointer/click events from bubbling into host
+     * outside-click handlers (Silk/Vaul/Radix), so a host bottom sheet/dialog
+     * stays open when the user taps the Lumen trigger. Default `true`. Hosts that
+     * listen in the capture phase should still guard with `isLumenEventTarget`.
+     */
+    isolateEvents?: boolean;
+    /**
+     * Soft-keyboard height (CSS px) for WebView hosts where
+     * `window.visualViewport` does NOT shrink (iOS WKWebView). When set, the
+     * trigger lifts above the keyboard and the modal keeps its focused input
+     * visible. Prefer `setLumenKeyboardInset()` from injected JS for a native
+     * shell; this prop is for same-process hosts that already track the height.
+     */
+    keyboardInset?: number;
+    /**
+     * Hide the floating/notch trigger while a host overlay owns the screen (the
+     * host's own modal, a full-screen route, etc.). The sheet stays openable
+     * programmatically via `useLumen().open()`. Default `false`.
+     */
+    suppressTrigger?: boolean;
     children: React.ReactNode;
 }
-declare function LumenProvider({ apiKey, apiUrl, user, amplitude, floatingButton, trigger, hideOn, theme, portalTarget, capture, record, shakeToOpen, onOpenChange, beforeOpen, onTriggerActivate, children, }: LumenProviderProps): react_jsx_runtime.JSX.Element;
+declare function LumenProvider({ apiKey, apiUrl, user, amplitude, floatingButton, trigger, hideOn, theme, portalTarget, capture, record, shakeToOpen, onOpenChange, beforeOpen, onTriggerActivate, isolateEvents, keyboardInset, suppressTrigger, children, }: LumenProviderProps): react_jsx_runtime.JSX.Element;
 
 interface FeedbackButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
     variant?: "default" | "ghost" | "outline";
@@ -240,6 +269,10 @@ interface LumenContextValue {
     initialCaptureError: Error | null;
     /** True while the trigger has been activated and the pre-open capture is running. */
     isOpening: boolean;
+    /** Whether Lumen stops its own pointer/click events from leaking into host overlays. */
+    isolateEvents: boolean;
+    /** Soft-keyboard inset override (px) from the host, when provided. */
+    keyboardInset: number | undefined;
     openCapture: (event?: Event) => void;
     closeCapture: () => void;
     isSubmitting: boolean;
@@ -247,4 +280,21 @@ interface LumenContextValue {
 }
 declare function useLumen(): LumenContextValue;
 
-export { CaptureModal, FeedbackButton, type FeedbackButtonProps, type FloatingTriggerConfig, type HeadlessTriggerConfig, type InlineTriggerConfig, type LumenContextValue, LumenProvider, type LumenProviderProps, type LumenTheme, type LumenTrigger, type LumenTriggerPlacement, type NotchEdge, type NotchTriggerConfig, useLumen };
+interface KeyboardInsetState {
+    /** True when the soft keyboard is judged to be covering the viewport. */
+    open: boolean;
+    /** Keyboard height (CSS px) to lift UI by. 0 when closed/unknown. */
+    inset: number;
+}
+/**
+ * Keyboard-awareness that works on web AND inside an iOS WKWebView.
+ *
+ * `window.visualViewport` does NOT shrink for the keyboard in a WKWebView, so a
+ * viewport-only approach silently fails there. This hook merges three sources
+ * (see {@link decideKeyboardInset}) and returns both whether the keyboard is
+ * open and how tall it is, so callers can lift the trigger / modal input above
+ * it rather than just hiding them.
+ */
+declare function useKeyboardInset(enabled: boolean, override?: number): KeyboardInsetState;
+
+export { CaptureModal, FeedbackButton, type FeedbackButtonProps, type FloatingTriggerConfig, type HeadlessTriggerConfig, type InlineTriggerConfig, type KeyboardInsetState, type LumenContextValue, LumenProvider, type LumenProviderProps, type LumenTheme, type LumenTrigger, type LumenTriggerPlacement, type NotchEdge, type NotchTriggerConfig, useKeyboardInset, useLumen };