react-native-keyboard-controller 1.17.1 → 1.17.2

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/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/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/lib/module/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":[]}