react-native-keyboard-controller 1.17.1 → 1.17.3

package/src/hooks/useKeyboardState/index.ts

@@ -12,6 +12,26 @@ const getLatestState = () => ({
   isVisible: KeyboardController.isVisible(),
 });
 
+/**
+ * React Hook that represents the current keyboard state on iOS and Android.
+ * It tracks keyboard visibility, height, appearance, type and other properties.
+ * This hook subscribes to keyboard events and updates the state reactively.
+ *
+ * @returns Object {@link KeyboardState|containing} keyboard state information.
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/hooks/keyboard/use-keyboard-state|Documentation} page for more details.
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { isVisible, height } = useKeyboardState();
+ *   return (
+ *     <View>
+ *       <Text>Keyboard is {isVisible ? 'visible' : 'hidden'}</Text>
+ *       <Text>Keyboard height: {height}</Text>
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
 export const useKeyboardState = (): KeyboardState => {
   const [state, setState] = useState(getLatestState);
 

package/src/hooks/useWindowDimensions/index.ts

@@ -1 +1,41 @@
-export { useWindowDimensions } from "react-native";
+import { useEffect, useState } from "react";
+import { Dimensions } from "react-native";
+
+import { WindowDimensionsEvents } from "../../bindings";
+
+import type { WindowDimensionsEventData } from "../../types";
+
+const screen = Dimensions.get("screen");
+
+let initialDimensions: WindowDimensionsEventData = {
+  width: screen.width,
+  height: screen.height,
+};
+
+WindowDimensionsEvents.addListener("windowDidResize", (e) => {
+  initialDimensions = e;
+});
+
+export const useWindowDimensions = () => {
+  const [dimensions, setDimensions] = useState(initialDimensions);
+
+  useEffect(() => {
+    const subscription = WindowDimensionsEvents.addListener(
+      "windowDidResize",
+      (e) => {
+        setDimensions(e);
+      },
+    );
+
+    // we might have missed an update between reading a value in render and
+    // `addListener` in this handler, so we set it here. If there was
+    // no change, React will filter out this update as a no-op.
+    setDimensions(initialDimensions);
+
+    return () => {
+      subscription.remove();
+    };
+  }, []);
+
+  return dimensions;
+};

package/src/internal.ts

@@ -7,6 +7,20 @@ import { findNodeHandle } from "./utils/findNodeHandle";
 type EventHandler = (event: never) => void;
 type ComponentOrHandle = Parameters<typeof findNodeHandle>[0];
 
+/**
+ * An internal hook that helps to register workletized event handlers.
+ *
+ * @param map - Map of event handlers and their names.
+ * @param viewTagRef - Ref to the view that produces events.
+ * @returns A function that registers supplied event handlers.
+ * @example
+ * ```ts
+ * const setKeyboardHandlers = useEventHandlerRegistration<KeyboardHandler>(
+ *     keyboardEventsMap,
+ *     viewTagRef,
+ * );
+ * ```
+ */
 export function useEventHandlerRegistration<
   H extends Partial<Record<string, EventHandler>>,
 >(
@@ -68,7 +82,14 @@ export function useEventHandlerRegistration<
  * and therefore consumes less memory. We can not use a variant from
  * RN, since this library supports earlier versions of RN.
  *
+ * @param initialValue - Initial value of the animated value (numeric).
+ * @param config - Additional {@link Animated.AnimatedConfig|configuration} for the animated value.
+ * @returns Properly memoized {@link Animated.Value|Animated} value.
  * @see https://github.com/facebook/react-native/commit/e22217fe8b9455e32695f88ca835e11442b0a937
+ * @example
+ * ```ts
+ * const progress = useAnimatedValue(0);
+ * ```
  */
 export function useAnimatedValue(
   initialValue: number,

package/src/module.ts

@@ -47,6 +47,9 @@ const dismiss = async (options?: DismissOptions): Promise<void> => {
 const isVisible = () => !isClosed;
 const state = () => lastState;
 
+/**
+ * KeyboardController module. Helps to perform imperative actions/checks with keyboard.
+ */
 export const KeyboardController: KeyboardControllerModule = {
   setDefaultMode: KeyboardControllerNative.setDefaultMode,
   setInputMode: KeyboardControllerNative.setInputMode,

package/src/monkey-patch.android.ts

@@ -20,12 +20,9 @@ const ModifiedNativeAndroidManager = {
   setTranslucent: (translucent: boolean): void => {
     RCTStatusBarManagerCompat.setTranslucent(translucent);
   },
-  /**
-   *  - statusBarStyles can be:
-   *    - 'default'
-   *    - 'dark-content'
-   */
-  setStyle: (statusBarStyle?: string): void => {
+  setStyle: (
+    statusBarStyle?: "default" | "dark-content" | "light-content",
+  ): void => {
     RCTStatusBarManagerCompat.setStyle(statusBarStyle);
   },
   setHidden: (hidden: boolean): void => {

package/src/{types.ts → types/hooks.ts}

@@ -1,44 +1,60 @@
-import type { PropsWithChildren } from "react";
-import type {
-  EmitterSubscription,
-  NativeSyntheticEvent,
-  TextInputProps,
-  ViewProps,
-} from "react-native";
+import type { NativeSyntheticEvent, ViewProps } from "react-native";
 
 // DirectEventHandler events declaration
 export type NativeEvent = {
+  /** A value between `0` and `1` indicating keyboard position, where `0` means keyboard is closed and `1` means keyboard is fully visible. */
   progress: number;
+  /** Height of the keyboard. */
   height: number;
+  /** Duration of the keyboard animation. */
   duration: number;
+  /** Tag of the focused `TextInput`. */
   target: number;
 };
 export type FocusedInputLayoutChangedEvent = {
+  /** Tag of the focused `TextInput`. */
   target: number;
+  /** Tag of the parent `ScrollView`. */
   parentScrollViewTarget: number;
   layout: {
+    /** X coordinate of the focused `TextInput`. */
     x: number;
+    /** Y coordinate of the focused `TextInput`. */
     y: number;
+    /** Width of the focused `TextInput`. */
     width: number;
+    /** Height of the focused `TextInput`. */
     height: number;
+    /** X coordinate of the focused `TextInput` relative to the screen. */
     absoluteX: number;
+    /** Y coordinate of the focused `TextInput` relative to the screen. */
     absoluteY: number;
   };
 };
 export type FocusedInputTextChangedEvent = {
+  /** Text that user typed in the focused `TextInput`. */
   text: string;
 };
 export type FocusedInputSelectionChangedEvent = {
+  /** Tag of the focused `TextInput`. */
   target: number;
   selection: {
+    /** Start of the selection. Represents top-left point of rectangle. */
     start: {
+      /** X coordinate of the selection start (relative to the `TextInput`). */
       x: number;
+      /** Y coordinate of the selection start (relative to the `TextInput`). */
       y: number;
+      /** The start of selection. */
       position: number;
     };
+    /** End of the selection. Represents bottom-right point of rectangle. */
     end: {
+      /** X coordinate of the selection end (relative to the `TextInput`). */
       x: number;
+      /** Y coordinate of the selection end (relative to the `TextInput`). */
       y: number;
+      /** The end of selection. */
       position: number;
     };
   };
@@ -93,104 +109,6 @@ export type KeyboardControllerProps = {
   enabled?: boolean;
 } & ViewProps;
 
-export type KeyboardGestureAreaProps = {
-  interpolator?: "ios" | "linear";
-  /**
-   * Whether to allow to show a keyboard from dismissed state by swipe up.
-   * Default to `false`.
-   */
-  showOnSwipeUp?: boolean;
-  /**
-   * Whether to allow to control a keyboard by gestures. The strategy how
-   * it should be controlled is determined by `interpolator` property.
-   * Defaults to `true`.
-   */
-  enableSwipeToDismiss?: boolean;
-  /**
-   * Extra distance to the keyboard.
-   */
-  offset?: number;
-  /**
-   * A corresponding `nativeID` value from the corresponding `TextInput`.
-   */
-  textInputNativeID?: string;
-} & ViewProps;
-export type OverKeyboardViewProps = PropsWithChildren<{
-  visible: boolean;
-}>;
-
-export type Direction = "next" | "prev" | "current";
-export type DismissOptions = {
-  keepFocus: boolean;
-};
-export type KeyboardControllerModule = {
-  // android only
-  setDefaultMode: () => void;
-  setInputMode: (mode: number) => void;
-  // all platforms
-  dismiss: (options?: DismissOptions) => Promise<void>;
-  setFocusTo: (direction: Direction) => void;
-  isVisible: () => boolean;
-  state: () => KeyboardEventData;
-};
-export type KeyboardControllerNativeModule = {
-  // android only
-  setDefaultMode: () => void;
-  setInputMode: (mode: number) => void;
-  // all platforms
-  dismiss: (keepFocus: boolean) => void;
-  setFocusTo: (direction: Direction) => void;
-  // native event module stuff
-  addListener: (eventName: string) => void;
-  removeListeners: (count: number) => void;
-};
-
-// Event module declarations
-export type KeyboardControllerEvents =
-  | "keyboardWillShow"
-  | "keyboardDidShow"
-  | "keyboardWillHide"
-  | "keyboardDidHide";
-export type KeyboardEventData = {
-  height: number;
-  duration: number;
-  timestamp: number;
-  target: number;
-  type: NonNullable<TextInputProps["keyboardType"]>;
-  appearance: NonNullable<TextInputProps["keyboardAppearance"]>;
-};
-export type KeyboardState = {
-  isVisible: boolean;
-} & KeyboardEventData;
-export type KeyboardEventsModule = {
-  addListener: (
-    name: KeyboardControllerEvents,
-    cb: (e: KeyboardEventData) => void,
-  ) => EmitterSubscription;
-};
-export type FocusedInputAvailableEvents = "focusDidSet";
-export type FocusedInputEventData = {
-  current: number;
-  count: number;
-};
-export type FocusedInputEventsModule = {
-  addListener: (
-    name: FocusedInputAvailableEvents,
-    cb: (e: FocusedInputEventData) => void,
-  ) => EmitterSubscription;
-};
-export type WindowDimensionsAvailableEvents = "windowDidResize";
-export type WindowDimensionsEventData = {
-  width: number;
-  height: number;
-};
-export type WindowDimensionsEventsModule = {
-  addListener: (
-    name: WindowDimensionsAvailableEvents,
-    cb: (e: WindowDimensionsEventData) => void,
-  ) => EmitterSubscription;
-};
-
 // reanimated hook declaration
 export type KeyboardHandlerHook<TContext, Event> = (
   handlers: {
@@ -232,14 +150,63 @@ export type FocusedInputSelectionHandlerHook<TContext, Event> = (
 // package types
 export type Handlers<T> = Record<string, T | undefined>;
 export type KeyboardHandler = Partial<{
+  /**
+   * A callback that gets invoked when keyboard starts its movement.
+   * The event contains DESTINATION values.
+   *
+   * @example
+   * ```ts
+   * onStart: (e) => {
+   *   "worklet";
+   *
+   *   const willKeyboardAppear = e.progress === 1;
+   * }
+   * ```
+   */
   onStart: (e: NativeEvent) => void;
+  /**
+   * A callback that gets involved every frame when keyboard changes its position.
+   *
+   * @example
+   * ```ts
+   * onMove: (e) => {
+   *   "worklet";
+   *
+   *   const keyboardHeight = e.height;
+   * }
+   */
   onMove: (e: NativeEvent) => void;
+  /**
+   * A callback that gets invoked when keyboard finished its movement.
+   *
+   * @example
+   * ```ts
+   * onEnd: (e) => {
+   *   "worklet";
+   *
+   *   const isKeyboardShown = e.progress === 1;
+   * }
+   * ```
+   */
   onEnd: (e: NativeEvent) => void;
+  /**
+   * A callback that gets invoked every frame when keyboard changes its position due to interactive dismissal.
+   *
+   * @example
+   * ```ts
+   * onInteractive: (e) => {
+   *   "worklet";
+   *
+   *   const keyboardHeight = e.height;
+   * }
+   */
   onInteractive: (e: NativeEvent) => void;
 }>;
 export type KeyboardHandlers = Handlers<KeyboardHandler>;
 export type FocusedInputHandler = Partial<{
+  /** A callback that gets invoked every time when the text changes in focused input. */
   onChangeText: (e: FocusedInputTextChangedEvent) => void;
+  /** A callback that gets invoked every time when the selection (cursor) coordinates change in focused input. */
   onSelectionChange: (e: FocusedInputSelectionChangedEvent) => void;
 }>;
 export type FocusedInputHandlers = Handlers<FocusedInputHandler>;

package/src/types/index.ts

@@ -0,0 +1,4 @@
+export * from "./hooks";
+export * from "./views";
+export * from "./module";
+export * from "./internal";

package/src/types/internal.ts

@@ -0,0 +1,24 @@
+import type { EmitterSubscription } from "react-native";
+
+export type FocusedInputAvailableEvents = "focusDidSet";
+export type FocusedInputEventData = {
+  current: number;
+  count: number;
+};
+export type FocusedInputEventsModule = {
+  addListener: (
+    name: FocusedInputAvailableEvents,
+    cb: (e: FocusedInputEventData) => void,
+  ) => EmitterSubscription;
+};
+export type WindowDimensionsAvailableEvents = "windowDidResize";
+export type WindowDimensionsEventData = {
+  width: number;
+  height: number;
+};
+export type WindowDimensionsEventsModule = {
+  addListener: (
+    name: WindowDimensionsAvailableEvents,
+    cb: (e: WindowDimensionsEventData) => void,
+  ) => EmitterSubscription;
+};

package/src/types/module.ts

@@ -0,0 +1,105 @@
+import type { EmitterSubscription, TextInputProps } from "react-native";
+
+// Event module declarations
+export type KeyboardControllerEvents =
+  | "keyboardWillShow"
+  | "keyboardDidShow"
+  | "keyboardWillHide"
+  | "keyboardDidHide";
+export type KeyboardEventData = {
+  /** Height of the keyboard. */
+  height: number;
+  /** Duration of the keyboard animation. */
+  duration: number;
+  /** Timestamp of the last keyboard event. */
+  timestamp: number;
+  /** Tag of the focused `TextInput`. */
+  target: number;
+  /** `keyboardType` property from focused `TextInput`. */
+  type: NonNullable<TextInputProps["keyboardType"]>;
+  /** Keyboard appearance. Can be one of `default`, `dark` or `light`. */
+  appearance: NonNullable<TextInputProps["keyboardAppearance"]>;
+};
+/**
+ * An object that represent current keyboard state.
+ */
+export type KeyboardState = {
+  /** Whether the keyboard is currently visible. */
+  isVisible: boolean;
+} & KeyboardEventData;
+export type KeyboardEventsModule = {
+  /**
+   * The `addListener` function connects a JavaScript function to an identified native
+   * keyboard notification event.
+   *
+   * This function then returns the reference to the listener.
+   *
+   * `name` is the string that identifies the event you're listening for. This
+   * can be any of the following:
+   *
+   * - `keyboardWillShow`;
+   * - `keyboardDidShow`;
+   * - `keyboardWillHide`;
+   * - `keyboardDidHide`.
+   */
+  addListener: (
+    name: KeyboardControllerEvents,
+    cb: (e: KeyboardEventData) => void,
+  ) => EmitterSubscription;
+};
+export type Direction = "next" | "prev" | "current";
+export type DismissOptions = {
+  /**
+   * A boolean property indicating whether focus should be kept on the input after dismissing the keyboard. Default is `false`.
+   */
+  keepFocus: boolean;
+};
+export type KeyboardControllerModule = {
+  // android only
+  /**
+   * Sets default `windowSoftInputMode` (the one that declared in `AndroidManifest.xml`).
+   *
+   * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#setdefaultmode-|docs} page for more details.
+   */
+  setDefaultMode: () => void;
+  /**
+   * Changes `windowSoftInputMode` on Android. @see AndroidSoftInputModes for all possible values and {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#setinputmode-|docs} page for more details.
+   */
+  setInputMode: (mode: number) => void;
+  // all platforms
+  /**
+   * Dismisses the active keyboard. Removes a focus by default, but allows to pass `{keepFocus: true}` to keep focus.
+   *
+   * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#dismiss|docs} page for more details.
+   */
+  dismiss: (options?: DismissOptions) => Promise<void>;
+  /**
+   * Moves focus to the specified direction (`next`, `prev` or `current` to restore a focus).
+   *
+   * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#setfocusto|docs} page for more details.
+   */
+  setFocusTo: (direction: Direction) => void;
+  /**
+   * Whether the keyboard is fully visible.
+   *
+   * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#isvisible|docs} page for more details.
+   */
+  isVisible: () => boolean;
+  /**
+   * Method that returns current keyboard state.
+   *
+   * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#state|docs} page for more details.
+   */
+  state: () => KeyboardEventData;
+};
+export type KeyboardControllerNativeModule = {
+  // android only
+  setDefaultMode: () => void;
+  setInputMode: (mode: number) => void;
+  // all platforms
+  dismiss: (keepFocus: boolean) => void;
+  setFocusTo: (direction: Direction) => void;
+  // native event module stuff
+  addListener: (eventName: string) => void;
+  removeListeners: (count: number) => void;
+};

package/src/types/views.ts

@@ -0,0 +1,46 @@
+import type { PropsWithChildren } from "react";
+import type { ViewProps } from "react-native";
+
+export type KeyboardGestureAreaProps = {
+  /**
+   * Determines how the keyboard position will be controlled:
+   * - `ios` - keyboard will be following finger only when finger touches keyboard
+   * - `linear` - keyboard will be following finger position linearly.
+   *
+   * @platform android
+   */
+  interpolator?: "ios" | "linear";
+  /**
+   * Whether to allow to show a keyboard from dismissed state by swipe up.
+   * Default to `false`.
+   *
+   * @platform android
+   */
+  showOnSwipeUp?: boolean;
+  /**
+   * Whether to allow to control a keyboard by gestures. The strategy how
+   * it should be controlled is determined by `interpolator` property.
+   * Defaults to `true`.
+   *
+   * @platform android
+   */
+  enableSwipeToDismiss?: boolean;
+  /**
+   * Extra distance to the keyboard.
+   */
+  offset?: number;
+  /**
+   * A corresponding `nativeID` value from the associated `TextInput` (a string that links the `KeyboardGestureArea` to one or more `TextInput` components).
+   * This is **required on iOS** in order to apply the `offset` when the keyboard is shown. Only the currently focused `TextInput` with a matching `nativeID`
+   * will receive offset behavior.
+   *
+   * @platform ios
+   */
+  textInputNativeID?: string;
+} & ViewProps;
+export type OverKeyboardViewProps = PropsWithChildren<{
+  /**
+   * A boolean prop indicating whether the view is visible or not. If it's true then view is shown on the screen. If it's false then view is hidden.
+   */
+  visible: boolean;
+}>;

package/src/views/OverKeyboardView/index.tsx

@@ -7,10 +7,21 @@ import { useWindowDimensions } from "../../hooks";
 import type { OverKeyboardViewProps } from "../../types";
 import type { PropsWithChildren } from "react";
 
-const OverKeyboardView = ({
-  children,
-  visible,
-}: PropsWithChildren<OverKeyboardViewProps>) => {
+/**
+ * A view component that renders its children over the keyboard without closing the keyboard.
+ * Acts similar to modal, but doesn't close the keyboard when it's visible.
+ *
+ * @param props - Component props.
+ * @returns A view component that renders over the keyboard.
+ * @example
+ * ```tsx
+ * <OverKeyboardView visible={true}>
+ *   <Text>This will appear over the keyboard</Text>
+ * </OverKeyboardView>
+ * ```
+ */
+const OverKeyboardView = (props: PropsWithChildren<OverKeyboardViewProps>) => {
+  const { children, visible } = props;
   const { height, width } = useWindowDimensions();
   const inner = useMemo(() => ({ height, width }), [height, width]);
   const style = useMemo(

package/lib/commonjs/hooks/useWindowDimensions/index.android.js

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useWindowDimensions = void 0;
-var _react = require("react");
-var _bindings = require("../../bindings");
-let initialDimensions = {
-  width: 0,
-  height: 0
-};
-_bindings.WindowDimensionsEvents.addListener("windowDidResize", e => {
-  initialDimensions = e;
-});
-const useWindowDimensions = () => {
-  const [dimensions, setDimensions] = (0, _react.useState)(initialDimensions);
-  (0, _react.useEffect)(() => {
-    const subscription = _bindings.WindowDimensionsEvents.addListener("windowDidResize", e => {
-      setDimensions(e);
-    });
-
-    // we might have missed an update between reading a value in render and
-    // `addListener` in this handler, so we set it here. If there was
-    // no change, React will filter out this update as a no-op.
-    setDimensions(initialDimensions);
-    return () => {
-      subscription.remove();
-    };
-  }, []);
-  return dimensions;
-};
-exports.useWindowDimensions = useWindowDimensions;
-//# sourceMappingURL=index.android.js.map

package/lib/commonjs/hooks/useWindowDimensions/index.android.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_react","require","_bindings","initialDimensions","width","height","WindowDimensionsEvents","addListener","e","useWindowDimensions","dimensions","setDimensions","useState","useEffect","subscription","remove","exports"],"sources":["index.android.ts"],"sourcesContent":["import { useEffect, useState } from \"react\";\n\nimport { WindowDimensionsEvents } from \"../../bindings\";\n\nimport type { WindowDimensionsEventData } from \"../../types\";\n\nlet initialDimensions: WindowDimensionsEventData = {\n  width: 0,\n  height: 0,\n};\n\nWindowDimensionsEvents.addListener(\"windowDidResize\", (e) => {\n  initialDimensions = e;\n});\n\nexport const useWindowDimensions = () => {\n  const [dimensions, setDimensions] = useState(initialDimensions);\n\n  useEffect(() => {\n    const subscription = WindowDimensionsEvents.addListener(\n      \"windowDidResize\",\n      (e) => {\n        setDimensions(e);\n      },\n    );\n\n    // we might have missed an update between reading a value in render and\n    // `addListener` in this handler, so we set it here. If there was\n    // no change, React will filter out this update as a no-op.\n    setDimensions(initialDimensions);\n\n    return () => {\n      subscription.remove();\n    };\n  }, []);\n\n  return dimensions;\n};\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,SAAA,GAAAD,OAAA;AAIA,IAAIE,iBAA4C,GAAG;EACjDC,KAAK,EAAE,CAAC;EACRC,MAAM,EAAE;AACV,CAAC;AAEDC,gCAAsB,CAACC,WAAW,CAAC,iBAAiB,EAAGC,CAAC,IAAK;EAC3DL,iBAAiB,GAAGK,CAAC;AACvB,CAAC,CAAC;AAEK,MAAMC,mBAAmB,GAAGA,CAAA,KAAM;EACvC,MAAM,CAACC,UAAU,EAAEC,aAAa,CAAC,GAAG,IAAAC,eAAQ,EAACT,iBAAiB,CAAC;EAE/D,IAAAU,gBAAS,EAAC,MAAM;IACd,MAAMC,YAAY,GAAGR,gCAAsB,CAACC,WAAW,CACrD,iBAAiB,EAChBC,CAAC,IAAK;MACLG,aAAa,CAACH,CAAC,CAAC;IAClB,CACF,CAAC;;IAED;IACA;IACA;IACAG,aAAa,CAACR,iBAAiB,CAAC;IAEhC,OAAO,MAAM;MACXW,YAAY,CAACC,MAAM,CAAC,CAAC;IACvB,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,OAAOL,UAAU;AACnB,CAAC;AAACM,OAAA,CAAAP,mBAAA,GAAAA,mBAAA","ignoreList":[]}

package/lib/commonjs/types.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { PropsWithChildren } from \"react\";\nimport type {\n  EmitterSubscription,\n  NativeSyntheticEvent,\n  TextInputProps,\n  ViewProps,\n} from \"react-native\";\n\n// DirectEventHandler events declaration\nexport type NativeEvent = {\n  progress: number;\n  height: number;\n  duration: number;\n  target: number;\n};\nexport type FocusedInputLayoutChangedEvent = {\n  target: number;\n  parentScrollViewTarget: number;\n  layout: {\n    x: number;\n    y: number;\n    width: number;\n    height: number;\n    absoluteX: number;\n    absoluteY: number;\n  };\n};\nexport type FocusedInputTextChangedEvent = {\n  text: string;\n};\nexport type FocusedInputSelectionChangedEvent = {\n  target: number;\n  selection: {\n    start: {\n      x: number;\n      y: number;\n      position: number;\n    };\n    end: {\n      x: number;\n      y: number;\n      position: number;\n    };\n  };\n};\nexport type EventWithName<T> = {\n  eventName: string;\n} & T;\n\n// native View/Module declarations\nexport type KeyboardControllerProps = {\n  //ref prop\n  ref?: React.Ref<React.Component<KeyboardControllerProps>>;\n  // callback props\n  onKeyboardMoveStart?: (\n    e: NativeSyntheticEvent<EventWithName<NativeEvent>>,\n  ) => void;\n  onKeyboardMove?: (\n    e: NativeSyntheticEvent<EventWithName<NativeEvent>>,\n  ) => void;\n  onKeyboardMoveEnd?: (\n    e: NativeSyntheticEvent<EventWithName<NativeEvent>>,\n  ) => void;\n  onKeyboardMoveInteractive?: (\n    e: NativeSyntheticEvent<EventWithName<NativeEvent>>,\n  ) => void;\n  onFocusedInputLayoutChanged?: (\n    e: NativeSyntheticEvent<EventWithName<FocusedInputLayoutChangedEvent>>,\n  ) => void;\n  onFocusedInputTextChanged?: (\n    e: NativeSyntheticEvent<EventWithName<FocusedInputTextChangedEvent>>,\n  ) => void;\n  onFocusedInputSelectionChanged?: (\n    e: NativeSyntheticEvent<EventWithName<FocusedInputSelectionChangedEvent>>,\n  ) => void;\n  // fake props used to activate reanimated bindings\n  onKeyboardMoveReanimated?: (\n    e: NativeSyntheticEvent<EventWithName<NativeEvent>>,\n  ) => void;\n  onFocusedInputLayoutChangedReanimated?: (\n    e: NativeSyntheticEvent<EventWithName<FocusedInputLayoutChangedEvent>>,\n  ) => void;\n  onFocusedInputTextChangedReanimated?: (\n    e: NativeSyntheticEvent<EventWithName<FocusedInputTextChangedEvent>>,\n  ) => void;\n  onFocusedInputSelectionChangedReanimated?: (\n    e: NativeSyntheticEvent<EventWithName<FocusedInputSelectionChangedEvent>>,\n  ) => void;\n  // props\n  statusBarTranslucent?: boolean;\n  navigationBarTranslucent?: boolean;\n  preserveEdgeToEdge?: boolean;\n  enabled?: boolean;\n} & ViewProps;\n\nexport type KeyboardGestureAreaProps = {\n  interpolator?: \"ios\" | \"linear\";\n  /**\n   * Whether to allow to show a keyboard from dismissed state by swipe up.\n   * Default to `false`.\n   */\n  showOnSwipeUp?: boolean;\n  /**\n   * Whether to allow to control a keyboard by gestures. The strategy how\n   * it should be controlled is determined by `interpolator` property.\n   * Defaults to `true`.\n   */\n  enableSwipeToDismiss?: boolean;\n  /**\n   * Extra distance to the keyboard.\n   */\n  offset?: number;\n  /**\n   * A corresponding `nativeID` value from the corresponding `TextInput`.\n   */\n  textInputNativeID?: string;\n} & ViewProps;\nexport type OverKeyboardViewProps = PropsWithChildren<{\n  visible: boolean;\n}>;\n\nexport type Direction = \"next\" | \"prev\" | \"current\";\nexport type DismissOptions = {\n  keepFocus: boolean;\n};\nexport type KeyboardControllerModule = {\n  // android only\n  setDefaultMode: () => void;\n  setInputMode: (mode: number) => void;\n  // all platforms\n  dismiss: (options?: DismissOptions) => Promise<void>;\n  setFocusTo: (direction: Direction) => void;\n  isVisible: () => boolean;\n  state: () => KeyboardEventData;\n};\nexport type KeyboardControllerNativeModule = {\n  // android only\n  setDefaultMode: () => void;\n  setInputMode: (mode: number) => void;\n  // all platforms\n  dismiss: (keepFocus: boolean) => void;\n  setFocusTo: (direction: Direction) => void;\n  // native event module stuff\n  addListener: (eventName: string) => void;\n  removeListeners: (count: number) => void;\n};\n\n// Event module declarations\nexport type KeyboardControllerEvents =\n  | \"keyboardWillShow\"\n  | \"keyboardDidShow\"\n  | \"keyboardWillHide\"\n  | \"keyboardDidHide\";\nexport type KeyboardEventData = {\n  height: number;\n  duration: number;\n  timestamp: number;\n  target: number;\n  type: NonNullable<TextInputProps[\"keyboardType\"]>;\n  appearance: NonNullable<TextInputProps[\"keyboardAppearance\"]>;\n};\nexport type KeyboardState = {\n  isVisible: boolean;\n} & KeyboardEventData;\nexport type KeyboardEventsModule = {\n  addListener: (\n    name: KeyboardControllerEvents,\n    cb: (e: KeyboardEventData) => void,\n  ) => EmitterSubscription;\n};\nexport type FocusedInputAvailableEvents = \"focusDidSet\";\nexport type FocusedInputEventData = {\n  current: number;\n  count: number;\n};\nexport type FocusedInputEventsModule = {\n  addListener: (\n    name: FocusedInputAvailableEvents,\n    cb: (e: FocusedInputEventData) => void,\n  ) => EmitterSubscription;\n};\nexport type WindowDimensionsAvailableEvents = \"windowDidResize\";\nexport type WindowDimensionsEventData = {\n  width: number;\n  height: number;\n};\nexport type WindowDimensionsEventsModule = {\n  addListener: (\n    name: WindowDimensionsAvailableEvents,\n    cb: (e: WindowDimensionsEventData) => void,\n  ) => EmitterSubscription;\n};\n\n// reanimated hook declaration\nexport type KeyboardHandlerHook<TContext, Event> = (\n  handlers: {\n    onKeyboardMoveStart?: (e: NativeEvent, context: TContext) => void;\n    onKeyboardMove?: (e: NativeEvent, context: TContext) => void;\n    onKeyboardMoveEnd?: (e: NativeEvent, context: TContext) => void;\n    onKeyboardMoveInteractive?: (e: NativeEvent, context: TContext) => void;\n  },\n  dependencies?: unknown[],\n) => (e: NativeSyntheticEvent<Event>) => void;\nexport type FocusedInputLayoutHandlerHook<TContext, Event> = (\n  handlers: {\n    onFocusedInputLayoutChanged?: (\n      e: FocusedInputLayoutChangedEvent,\n      context: TContext,\n    ) => void;\n  },\n  dependencies?: unknown[],\n) => (e: NativeSyntheticEvent<Event>) => void;\nexport type FocusedInputTextHandlerHook<TContext, Event> = (\n  handlers: {\n    onFocusedInputTextChanged?: (\n      e: FocusedInputTextChangedEvent,\n      context: TContext,\n    ) => void;\n  },\n  dependencies?: unknown[],\n) => (e: NativeSyntheticEvent<Event>) => void;\nexport type FocusedInputSelectionHandlerHook<TContext, Event> = (\n  handlers: {\n    onFocusedInputSelectionChanged?: (\n      e: FocusedInputSelectionChangedEvent,\n      context: TContext,\n    ) => void;\n  },\n  dependencies?: unknown[],\n) => (e: NativeSyntheticEvent<Event>) => void;\n\n// package types\nexport type Handlers<T> = Record<string, T | undefined>;\nexport type KeyboardHandler = Partial<{\n  onStart: (e: NativeEvent) => void;\n  onMove: (e: NativeEvent) => void;\n  onEnd: (e: NativeEvent) => void;\n  onInteractive: (e: NativeEvent) => void;\n}>;\nexport type KeyboardHandlers = Handlers<KeyboardHandler>;\nexport type FocusedInputHandler = Partial<{\n  onChangeText: (e: FocusedInputTextChangedEvent) => void;\n  onSelectionChange: (e: FocusedInputSelectionChangedEvent) => void;\n}>;\nexport type FocusedInputHandlers = Handlers<FocusedInputHandler>;\n"],"mappings":"","ignoreList":[]}

package/lib/module/hooks/useWindowDimensions/index.android.js

@@ -1,27 +0,0 @@
-import { useEffect, useState } from "react";
-import { WindowDimensionsEvents } from "../../bindings";
-let initialDimensions = {
-  width: 0,
-  height: 0
-};
-WindowDimensionsEvents.addListener("windowDidResize", e => {
-  initialDimensions = e;
-});
-export const useWindowDimensions = () => {
-  const [dimensions, setDimensions] = useState(initialDimensions);
-  useEffect(() => {
-    const subscription = WindowDimensionsEvents.addListener("windowDidResize", e => {
-      setDimensions(e);
-    });
-
-    // we might have missed an update between reading a value in render and
-    // `addListener` in this handler, so we set it here. If there was
-    // no change, React will filter out this update as a no-op.
-    setDimensions(initialDimensions);
-    return () => {
-      subscription.remove();
-    };
-  }, []);
-  return dimensions;
-};
-//# sourceMappingURL=index.android.js.map

package/lib/module/hooks/useWindowDimensions/index.android.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["useEffect","useState","WindowDimensionsEvents","initialDimensions","width","height","addListener","e","useWindowDimensions","dimensions","setDimensions","subscription","remove"],"sources":["index.android.ts"],"sourcesContent":["import { useEffect, useState } from \"react\";\n\nimport { WindowDimensionsEvents } from \"../../bindings\";\n\nimport type { WindowDimensionsEventData } from \"../../types\";\n\nlet initialDimensions: WindowDimensionsEventData = {\n  width: 0,\n  height: 0,\n};\n\nWindowDimensionsEvents.addListener(\"windowDidResize\", (e) => {\n  initialDimensions = e;\n});\n\nexport const useWindowDimensions = () => {\n  const [dimensions, setDimensions] = useState(initialDimensions);\n\n  useEffect(() => {\n    const subscription = WindowDimensionsEvents.addListener(\n      \"windowDidResize\",\n      (e) => {\n        setDimensions(e);\n      },\n    );\n\n    // we might have missed an update between reading a value in render and\n    // `addListener` in this handler, so we set it here. If there was\n    // no change, React will filter out this update as a no-op.\n    setDimensions(initialDimensions);\n\n    return () => {\n      subscription.remove();\n    };\n  }, []);\n\n  return dimensions;\n};\n"],"mappings":"AAAA,SAASA,SAAS,EAAEC,QAAQ,QAAQ,OAAO;AAE3C,SAASC,sBAAsB,QAAQ,gBAAgB;AAIvD,IAAIC,iBAA4C,GAAG;EACjDC,KAAK,EAAE,CAAC;EACRC,MAAM,EAAE;AACV,CAAC;AAEDH,sBAAsB,CAACI,WAAW,CAAC,iBAAiB,EAAGC,CAAC,IAAK;EAC3DJ,iBAAiB,GAAGI,CAAC;AACvB,CAAC,CAAC;AAEF,OAAO,MAAMC,mBAAmB,GAAGA,CAAA,KAAM;EACvC,MAAM,CAACC,UAAU,EAAEC,aAAa,CAAC,GAAGT,QAAQ,CAACE,iBAAiB,CAAC;EAE/DH,SAAS,CAAC,MAAM;IACd,MAAMW,YAAY,GAAGT,sBAAsB,CAACI,WAAW,CACrD,iBAAiB,EAChBC,CAAC,IAAK;MACLG,aAAa,CAACH,CAAC,CAAC;IAClB,CACF,CAAC;;IAED;IACA;IACA;IACAG,aAAa,CAACP,iBAAiB,CAAC;IAEhC,OAAO,MAAM;MACXQ,YAAY,CAACC,MAAM,CAAC,CAAC;IACvB,CAAC;EACH,CAAC,EAAE,EAAE,CAAC;EAEN,OAAOH,UAAU;AACnB,CAAC","ignoreList":[]}