react-native-keyboard-controller 1.17.1 → 1.17.3

package/lib/module/internal.js

@@ -2,6 +2,20 @@ import { useRef } from "react";
 import { Animated } from "react-native";
 import { registerEventHandler, unregisterEventHandler } from "./event-handler";
 import { findNodeHandle } from "./utils/findNodeHandle";
+/**
+ * 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(map, viewTagRef) {
   const onRegisterHandler = handler => {
     const ids = [];
@@ -43,7 +57,14 @@ export function useEventHandlerRegistration(map, viewTagRef) {
  * 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, config) {
   const ref = useRef(null);

package/lib/module/internal.js.map

@@ -1 +1 @@
-{"version":3,"names":["useRef","Animated","registerEventHandler","unregisterEventHandler","findNodeHandle","useEventHandlerRegistration","map","viewTagRef","onRegisterHandler","handler","ids","attachWorkletHandlers","viewTag","current","__DEV__","console","warn","push","Object","keys","handlerName","eventName","get","functionToCall","event","queueMicrotask","forEach","id","useAnimatedValue","initialValue","config","ref","Value"],"sources":["internal.ts"],"sourcesContent":["import { useRef } from \"react\";\nimport { Animated } from \"react-native\";\n\nimport { registerEventHandler, unregisterEventHandler } from \"./event-handler\";\nimport { findNodeHandle } from \"./utils/findNodeHandle\";\n\ntype EventHandler = (event: never) => void;\ntype ComponentOrHandle = Parameters<typeof findNodeHandle>[0];\n\nexport function useEventHandlerRegistration<\n  H extends Partial<Record<string, EventHandler>>,\n>(\n  map: Map<keyof H, string>,\n  viewTagRef: React.MutableRefObject<ComponentOrHandle>,\n) {\n  const onRegisterHandler = (handler: H) => {\n    const ids: (number | null)[] = [];\n    const attachWorkletHandlers = () => {\n      const viewTag = findNodeHandle(viewTagRef.current);\n\n      if (__DEV__ && !viewTag) {\n        console.warn(\n          \"Can not attach worklet handlers for `react-native-keyboard-controller` because view tag can not be resolved. Be sure that `KeyboardProvider` is fully mounted before registering handlers. If you think it is a bug in library, please open an issue.\",\n        );\n      }\n\n      ids.push(\n        ...Object.keys(handler).map((handlerName) => {\n          const eventName = map.get(handlerName as keyof H);\n          const functionToCall = handler[handlerName as keyof H];\n\n          if (eventName && viewTag) {\n            return registerEventHandler(\n              (event: Parameters<NonNullable<H[keyof H]>>[0]) => {\n                \"worklet\";\n\n                functionToCall?.(event);\n              },\n              eventName,\n              viewTag,\n            );\n          }\n\n          return null;\n        }),\n      );\n    };\n\n    if (viewTagRef.current) {\n      attachWorkletHandlers();\n    } else {\n      // view may not be mounted yet - defer registration until call-stack becomes empty\n      queueMicrotask(attachWorkletHandlers);\n    }\n\n    return () => {\n      ids.forEach((id) => (id ? unregisterEventHandler(id) : null));\n    };\n  };\n\n  return onRegisterHandler;\n}\n\n/**\n * TS variant of `useAnimatedValue` hook which is added in RN 0.71\n * A better alternative of storing animated values in refs, since\n * it doesn't recreate a new `Animated.Value` object on every re-render\n * and therefore consumes less memory. We can not use a variant from\n * RN, since this library supports earlier versions of RN.\n *\n * @see https://github.com/facebook/react-native/commit/e22217fe8b9455e32695f88ca835e11442b0a937\n */\nexport function useAnimatedValue(\n  initialValue: number,\n  config?: Animated.AnimatedConfig,\n): Animated.Value {\n  const ref = useRef<Animated.Value | null>(null);\n\n  if (ref.current === null) {\n    ref.current = new Animated.Value(initialValue, config);\n  }\n\n  return ref.current;\n}\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,OAAO;AAC9B,SAASC,QAAQ,QAAQ,cAAc;AAEvC,SAASC,oBAAoB,EAAEC,sBAAsB,QAAQ,iBAAiB;AAC9E,SAASC,cAAc,QAAQ,wBAAwB;AAKvD,OAAO,SAASC,2BAA2BA,CAGzCC,GAAyB,EACzBC,UAAqD,EACrD;EACA,MAAMC,iBAAiB,GAAIC,OAAU,IAAK;IACxC,MAAMC,GAAsB,GAAG,EAAE;IACjC,MAAMC,qBAAqB,GAAGA,CAAA,KAAM;MAClC,MAAMC,OAAO,GAAGR,cAAc,CAACG,UAAU,CAACM,OAAO,CAAC;MAElD,IAAIC,OAAO,IAAI,CAACF,OAAO,EAAE;QACvBG,OAAO,CAACC,IAAI,CACV,uPACF,CAAC;MACH;MAEAN,GAAG,CAACO,IAAI,CACN,GAAGC,MAAM,CAACC,IAAI,CAACV,OAAO,CAAC,CAACH,GAAG,CAAEc,WAAW,IAAK;QAC3C,MAAMC,SAAS,GAAGf,GAAG,CAACgB,GAAG,CAACF,WAAsB,CAAC;QACjD,MAAMG,cAAc,GAAGd,OAAO,CAACW,WAAW,CAAY;QAEtD,IAAIC,SAAS,IAAIT,OAAO,EAAE;UACxB,OAAOV,oBAAoB,CACxBsB,KAA6C,IAAK;YACjD,SAAS;;YAETD,cAAc,aAAdA,cAAc,eAAdA,cAAc,CAAGC,KAAK,CAAC;UACzB,CAAC,EACDH,SAAS,EACTT,OACF,CAAC;QACH;QAEA,OAAO,IAAI;MACb,CAAC,CACH,CAAC;IACH,CAAC;IAED,IAAIL,UAAU,CAACM,OAAO,EAAE;MACtBF,qBAAqB,CAAC,CAAC;IACzB,CAAC,MAAM;MACL;MACAc,cAAc,CAACd,qBAAqB,CAAC;IACvC;IAEA,OAAO,MAAM;MACXD,GAAG,CAACgB,OAAO,CAAEC,EAAE,IAAMA,EAAE,GAAGxB,sBAAsB,CAACwB,EAAE,CAAC,GAAG,IAAK,CAAC;IAC/D,CAAC;EACH,CAAC;EAED,OAAOnB,iBAAiB;AAC1B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASoB,gBAAgBA,CAC9BC,YAAoB,EACpBC,MAAgC,EAChB;EAChB,MAAMC,GAAG,GAAG/B,MAAM,CAAwB,IAAI,CAAC;EAE/C,IAAI+B,GAAG,CAAClB,OAAO,KAAK,IAAI,EAAE;IACxBkB,GAAG,CAAClB,OAAO,GAAG,IAAIZ,QAAQ,CAAC+B,KAAK,CAACH,YAAY,EAAEC,MAAM,CAAC;EACxD;EAEA,OAAOC,GAAG,CAAClB,OAAO;AACpB","ignoreList":[]}
+{"version":3,"names":["useRef","Animated","registerEventHandler","unregisterEventHandler","findNodeHandle","useEventHandlerRegistration","map","viewTagRef","onRegisterHandler","handler","ids","attachWorkletHandlers","viewTag","current","__DEV__","console","warn","push","Object","keys","handlerName","eventName","get","functionToCall","event","queueMicrotask","forEach","id","useAnimatedValue","initialValue","config","ref","Value"],"sources":["internal.ts"],"sourcesContent":["import { useRef } from \"react\";\nimport { Animated } from \"react-native\";\n\nimport { registerEventHandler, unregisterEventHandler } from \"./event-handler\";\nimport { findNodeHandle } from \"./utils/findNodeHandle\";\n\ntype EventHandler = (event: never) => void;\ntype ComponentOrHandle = Parameters<typeof findNodeHandle>[0];\n\n/**\n * An internal hook that helps to register workletized event handlers.\n *\n * @param map - Map of event handlers and their names.\n * @param viewTagRef - Ref to the view that produces events.\n * @returns A function that registers supplied event handlers.\n * @example\n * ```ts\n * const setKeyboardHandlers = useEventHandlerRegistration<KeyboardHandler>(\n *     keyboardEventsMap,\n *     viewTagRef,\n * );\n * ```\n */\nexport function useEventHandlerRegistration<\n  H extends Partial<Record<string, EventHandler>>,\n>(\n  map: Map<keyof H, string>,\n  viewTagRef: React.MutableRefObject<ComponentOrHandle>,\n) {\n  const onRegisterHandler = (handler: H) => {\n    const ids: (number | null)[] = [];\n    const attachWorkletHandlers = () => {\n      const viewTag = findNodeHandle(viewTagRef.current);\n\n      if (__DEV__ && !viewTag) {\n        console.warn(\n          \"Can not attach worklet handlers for `react-native-keyboard-controller` because view tag can not be resolved. Be sure that `KeyboardProvider` is fully mounted before registering handlers. If you think it is a bug in library, please open an issue.\",\n        );\n      }\n\n      ids.push(\n        ...Object.keys(handler).map((handlerName) => {\n          const eventName = map.get(handlerName as keyof H);\n          const functionToCall = handler[handlerName as keyof H];\n\n          if (eventName && viewTag) {\n            return registerEventHandler(\n              (event: Parameters<NonNullable<H[keyof H]>>[0]) => {\n                \"worklet\";\n\n                functionToCall?.(event);\n              },\n              eventName,\n              viewTag,\n            );\n          }\n\n          return null;\n        }),\n      );\n    };\n\n    if (viewTagRef.current) {\n      attachWorkletHandlers();\n    } else {\n      // view may not be mounted yet - defer registration until call-stack becomes empty\n      queueMicrotask(attachWorkletHandlers);\n    }\n\n    return () => {\n      ids.forEach((id) => (id ? unregisterEventHandler(id) : null));\n    };\n  };\n\n  return onRegisterHandler;\n}\n\n/**\n * TS variant of `useAnimatedValue` hook which is added in RN 0.71\n * A better alternative of storing animated values in refs, since\n * it doesn't recreate a new `Animated.Value` object on every re-render\n * and therefore consumes less memory. We can not use a variant from\n * RN, since this library supports earlier versions of RN.\n *\n * @param initialValue - Initial value of the animated value (numeric).\n * @param config - Additional {@link Animated.AnimatedConfig|configuration} for the animated value.\n * @returns Properly memoized {@link Animated.Value|Animated} value.\n * @see https://github.com/facebook/react-native/commit/e22217fe8b9455e32695f88ca835e11442b0a937\n * @example\n * ```ts\n * const progress = useAnimatedValue(0);\n * ```\n */\nexport function useAnimatedValue(\n  initialValue: number,\n  config?: Animated.AnimatedConfig,\n): Animated.Value {\n  const ref = useRef<Animated.Value | null>(null);\n\n  if (ref.current === null) {\n    ref.current = new Animated.Value(initialValue, config);\n  }\n\n  return ref.current;\n}\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,OAAO;AAC9B,SAASC,QAAQ,QAAQ,cAAc;AAEvC,SAASC,oBAAoB,EAAEC,sBAAsB,QAAQ,iBAAiB;AAC9E,SAASC,cAAc,QAAQ,wBAAwB;AAKvD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CAGzCC,GAAyB,EACzBC,UAAqD,EACrD;EACA,MAAMC,iBAAiB,GAAIC,OAAU,IAAK;IACxC,MAAMC,GAAsB,GAAG,EAAE;IACjC,MAAMC,qBAAqB,GAAGA,CAAA,KAAM;MAClC,MAAMC,OAAO,GAAGR,cAAc,CAACG,UAAU,CAACM,OAAO,CAAC;MAElD,IAAIC,OAAO,IAAI,CAACF,OAAO,EAAE;QACvBG,OAAO,CAACC,IAAI,CACV,uPACF,CAAC;MACH;MAEAN,GAAG,CAACO,IAAI,CACN,GAAGC,MAAM,CAACC,IAAI,CAACV,OAAO,CAAC,CAACH,GAAG,CAAEc,WAAW,IAAK;QAC3C,MAAMC,SAAS,GAAGf,GAAG,CAACgB,GAAG,CAACF,WAAsB,CAAC;QACjD,MAAMG,cAAc,GAAGd,OAAO,CAACW,WAAW,CAAY;QAEtD,IAAIC,SAAS,IAAIT,OAAO,EAAE;UACxB,OAAOV,oBAAoB,CACxBsB,KAA6C,IAAK;YACjD,SAAS;;YAETD,cAAc,aAAdA,cAAc,eAAdA,cAAc,CAAGC,KAAK,CAAC;UACzB,CAAC,EACDH,SAAS,EACTT,OACF,CAAC;QACH;QAEA,OAAO,IAAI;MACb,CAAC,CACH,CAAC;IACH,CAAC;IAED,IAAIL,UAAU,CAACM,OAAO,EAAE;MACtBF,qBAAqB,CAAC,CAAC;IACzB,CAAC,MAAM;MACL;MACAc,cAAc,CAACd,qBAAqB,CAAC;IACvC;IAEA,OAAO,MAAM;MACXD,GAAG,CAACgB,OAAO,CAAEC,EAAE,IAAMA,EAAE,GAAGxB,sBAAsB,CAACwB,EAAE,CAAC,GAAG,IAAK,CAAC;IAC/D,CAAC;EACH,CAAC;EAED,OAAOnB,iBAAiB;AAC1B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASoB,gBAAgBA,CAC9BC,YAAoB,EACpBC,MAAgC,EAChB;EAChB,MAAMC,GAAG,GAAG/B,MAAM,CAAwB,IAAI,CAAC;EAE/C,IAAI+B,GAAG,CAAClB,OAAO,KAAK,IAAI,EAAE;IACxBkB,GAAG,CAAClB,OAAO,GAAG,IAAIZ,QAAQ,CAAC+B,KAAK,CAACH,YAAY,EAAEC,MAAM,CAAC;EACxD;EAEA,OAAOC,GAAG,CAAClB,OAAO;AACpB","ignoreList":[]}

package/lib/module/module.js

@@ -32,6 +32,10 @@ const dismiss = async options => {
 };
 const isVisible = () => !isClosed;
 const state = () => lastState;
+
+/**
+ * KeyboardController module. Helps to perform imperative actions/checks with keyboard.
+ */
 export const KeyboardController = {
   setDefaultMode: KeyboardControllerNative.setDefaultMode,
   setInputMode: KeyboardControllerNative.setInputMode,

package/lib/module/module.js.map

@@ -1 +1 @@
-{"version":3,"names":["KeyboardControllerNative","KeyboardEvents","isClosed","lastState","height","duration","timestamp","Date","getTime","target","type","appearance","addListener","e","dismiss","options","keepFocus","Promise","resolve","subscription","undefined","remove","isVisible","state","KeyboardController","setDefaultMode","setInputMode","setFocusTo"],"sources":["module.ts"],"sourcesContent":["import { KeyboardControllerNative, KeyboardEvents } from \"./bindings\";\n\nimport type {\n  DismissOptions,\n  KeyboardControllerModule,\n  KeyboardEventData,\n} from \"./types\";\n\nlet isClosed = true;\nlet lastState: KeyboardEventData = {\n  height: 0,\n  duration: 0,\n  timestamp: new Date().getTime(),\n  target: -1,\n  type: \"default\",\n  appearance: \"default\",\n};\n\nKeyboardEvents.addListener(\"keyboardDidHide\", (e) => {\n  isClosed = true;\n  lastState = e;\n});\n\nKeyboardEvents.addListener(\"keyboardDidShow\", (e) => {\n  isClosed = false;\n  lastState = e;\n});\n\nconst dismiss = async (options?: DismissOptions): Promise<void> => {\n  const keepFocus = options?.keepFocus ?? false;\n\n  return new Promise((resolve) => {\n    if (isClosed) {\n      resolve();\n\n      return;\n    }\n\n    const subscription = KeyboardEvents.addListener(\"keyboardDidHide\", () => {\n      resolve(undefined);\n      subscription.remove();\n    });\n\n    KeyboardControllerNative.dismiss(keepFocus);\n  });\n};\nconst isVisible = () => !isClosed;\nconst state = () => lastState;\n\nexport const KeyboardController: KeyboardControllerModule = {\n  setDefaultMode: KeyboardControllerNative.setDefaultMode,\n  setInputMode: KeyboardControllerNative.setInputMode,\n  setFocusTo: KeyboardControllerNative.setFocusTo,\n  dismiss,\n  isVisible,\n  state,\n};\n"],"mappings":"AAAA,SAASA,wBAAwB,EAAEC,cAAc,QAAQ,YAAY;AAQrE,IAAIC,QAAQ,GAAG,IAAI;AACnB,IAAIC,SAA4B,GAAG;EACjCC,MAAM,EAAE,CAAC;EACTC,QAAQ,EAAE,CAAC;EACXC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC;EAC/BC,MAAM,EAAE,CAAC,CAAC;EACVC,IAAI,EAAE,SAAS;EACfC,UAAU,EAAE;AACd,CAAC;AAEDV,cAAc,CAACW,WAAW,CAAC,iBAAiB,EAAGC,CAAC,IAAK;EACnDX,QAAQ,GAAG,IAAI;EACfC,SAAS,GAAGU,CAAC;AACf,CAAC,CAAC;AAEFZ,cAAc,CAACW,WAAW,CAAC,iBAAiB,EAAGC,CAAC,IAAK;EACnDX,QAAQ,GAAG,KAAK;EAChBC,SAAS,GAAGU,CAAC;AACf,CAAC,CAAC;AAEF,MAAMC,OAAO,GAAG,MAAOC,OAAwB,IAAoB;EACjE,MAAMC,SAAS,GAAG,CAAAD,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEC,SAAS,KAAI,KAAK;EAE7C,OAAO,IAAIC,OAAO,CAAEC,OAAO,IAAK;IAC9B,IAAIhB,QAAQ,EAAE;MACZgB,OAAO,CAAC,CAAC;MAET;IACF;IAEA,MAAMC,YAAY,GAAGlB,cAAc,CAACW,WAAW,CAAC,iBAAiB,EAAE,MAAM;MACvEM,OAAO,CAACE,SAAS,CAAC;MAClBD,YAAY,CAACE,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC;IAEFrB,wBAAwB,CAACc,OAAO,CAACE,SAAS,CAAC;EAC7C,CAAC,CAAC;AACJ,CAAC;AACD,MAAMM,SAAS,GAAGA,CAAA,KAAM,CAACpB,QAAQ;AACjC,MAAMqB,KAAK,GAAGA,CAAA,KAAMpB,SAAS;AAE7B,OAAO,MAAMqB,kBAA4C,GAAG;EAC1DC,cAAc,EAAEzB,wBAAwB,CAACyB,cAAc;EACvDC,YAAY,EAAE1B,wBAAwB,CAAC0B,YAAY;EACnDC,UAAU,EAAE3B,wBAAwB,CAAC2B,UAAU;EAC/Cb,OAAO;EACPQ,SAAS;EACTC;AACF,CAAC","ignoreList":[]}
+{"version":3,"names":["KeyboardControllerNative","KeyboardEvents","isClosed","lastState","height","duration","timestamp","Date","getTime","target","type","appearance","addListener","e","dismiss","options","keepFocus","Promise","resolve","subscription","undefined","remove","isVisible","state","KeyboardController","setDefaultMode","setInputMode","setFocusTo"],"sources":["module.ts"],"sourcesContent":["import { KeyboardControllerNative, KeyboardEvents } from \"./bindings\";\n\nimport type {\n  DismissOptions,\n  KeyboardControllerModule,\n  KeyboardEventData,\n} from \"./types\";\n\nlet isClosed = true;\nlet lastState: KeyboardEventData = {\n  height: 0,\n  duration: 0,\n  timestamp: new Date().getTime(),\n  target: -1,\n  type: \"default\",\n  appearance: \"default\",\n};\n\nKeyboardEvents.addListener(\"keyboardDidHide\", (e) => {\n  isClosed = true;\n  lastState = e;\n});\n\nKeyboardEvents.addListener(\"keyboardDidShow\", (e) => {\n  isClosed = false;\n  lastState = e;\n});\n\nconst dismiss = async (options?: DismissOptions): Promise<void> => {\n  const keepFocus = options?.keepFocus ?? false;\n\n  return new Promise((resolve) => {\n    if (isClosed) {\n      resolve();\n\n      return;\n    }\n\n    const subscription = KeyboardEvents.addListener(\"keyboardDidHide\", () => {\n      resolve(undefined);\n      subscription.remove();\n    });\n\n    KeyboardControllerNative.dismiss(keepFocus);\n  });\n};\nconst isVisible = () => !isClosed;\nconst state = () => lastState;\n\n/**\n * KeyboardController module. Helps to perform imperative actions/checks with keyboard.\n */\nexport const KeyboardController: KeyboardControllerModule = {\n  setDefaultMode: KeyboardControllerNative.setDefaultMode,\n  setInputMode: KeyboardControllerNative.setInputMode,\n  setFocusTo: KeyboardControllerNative.setFocusTo,\n  dismiss,\n  isVisible,\n  state,\n};\n"],"mappings":"AAAA,SAASA,wBAAwB,EAAEC,cAAc,QAAQ,YAAY;AAQrE,IAAIC,QAAQ,GAAG,IAAI;AACnB,IAAIC,SAA4B,GAAG;EACjCC,MAAM,EAAE,CAAC;EACTC,QAAQ,EAAE,CAAC;EACXC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC;EAC/BC,MAAM,EAAE,CAAC,CAAC;EACVC,IAAI,EAAE,SAAS;EACfC,UAAU,EAAE;AACd,CAAC;AAEDV,cAAc,CAACW,WAAW,CAAC,iBAAiB,EAAGC,CAAC,IAAK;EACnDX,QAAQ,GAAG,IAAI;EACfC,SAAS,GAAGU,CAAC;AACf,CAAC,CAAC;AAEFZ,cAAc,CAACW,WAAW,CAAC,iBAAiB,EAAGC,CAAC,IAAK;EACnDX,QAAQ,GAAG,KAAK;EAChBC,SAAS,GAAGU,CAAC;AACf,CAAC,CAAC;AAEF,MAAMC,OAAO,GAAG,MAAOC,OAAwB,IAAoB;EACjE,MAAMC,SAAS,GAAG,CAAAD,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEC,SAAS,KAAI,KAAK;EAE7C,OAAO,IAAIC,OAAO,CAAEC,OAAO,IAAK;IAC9B,IAAIhB,QAAQ,EAAE;MACZgB,OAAO,CAAC,CAAC;MAET;IACF;IAEA,MAAMC,YAAY,GAAGlB,cAAc,CAACW,WAAW,CAAC,iBAAiB,EAAE,MAAM;MACvEM,OAAO,CAACE,SAAS,CAAC;MAClBD,YAAY,CAACE,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC;IAEFrB,wBAAwB,CAACc,OAAO,CAACE,SAAS,CAAC;EAC7C,CAAC,CAAC;AACJ,CAAC;AACD,MAAMM,SAAS,GAAGA,CAAA,KAAM,CAACpB,QAAQ;AACjC,MAAMqB,KAAK,GAAGA,CAAA,KAAMpB,SAAS;;AAE7B;AACA;AACA;AACA,OAAO,MAAMqB,kBAA4C,GAAG;EAC1DC,cAAc,EAAEzB,wBAAwB,CAACyB,cAAc;EACvDC,YAAY,EAAE1B,wBAAwB,CAAC0B,YAAY;EACnDC,UAAU,EAAE3B,wBAAwB,CAAC2B,UAAU;EAC/Cb,OAAO;EACPQ,SAAS;EACTC;AACF,CAAC","ignoreList":[]}

package/lib/module/monkey-patch.android.js

@@ -22,11 +22,6 @@ const ModifiedNativeAndroidManager = {
   setTranslucent: translucent => {
     RCTStatusBarManagerCompat.setTranslucent(translucent);
   },
-  /**
-   *  - statusBarStyles can be:
-   *    - 'default'
-   *    - 'dark-content'
-   */
   setStyle: statusBarStyle => {
     RCTStatusBarManagerCompat.setStyle(statusBarStyle);
   },

package/lib/module/monkey-patch.android.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeAndroidManager","RCTStatusBarManagerCompat","require","default","OriginalNativeAndroidManager","ModifiedNativeAndroidManager","setColor","color","animated","setTranslucent","translucent","setStyle","statusBarStyle","setHidden","hidden","applyMonkeyPatch","Object","assign","revertMonkeyPatch"],"sources":["monkey-patch.android.ts"],"sourcesContent":["// @ts-expect-error because there is no corresponding type definition\nimport * as NativeAndroidManager from \"react-native/Libraries/Components/StatusBar/NativeStatusBarManagerAndroid\";\n\nconst RCTStatusBarManagerCompat =\n  // eslint-disable-next-line @typescript-eslint/no-var-requires\n  require(\"./specs/NativeStatusBarManagerCompat\").default;\n\n// Copy original default manager to keep its original state and methods\nconst OriginalNativeAndroidManager = { ...NativeAndroidManager.default };\n\n// Create a new object that modifies the necessary methods\n// On Android < 11 RN uses legacy API which breaks EdgeToEdge mode in RN, so\n// in order to use library on all available platforms we have to monkey patch\n// default RN implementation and use modern `WindowInsetsControllerCompat`.\nconst ModifiedNativeAndroidManager = {\n  ...NativeAndroidManager.default, // Spread original properties to keep existing functionality\n  setColor: (color: number, animated: boolean): void => {\n    RCTStatusBarManagerCompat.setColor(color, animated);\n  },\n  setTranslucent: (translucent: boolean): void => {\n    RCTStatusBarManagerCompat.setTranslucent(translucent);\n  },\n  /**\n   *  - statusBarStyles can be:\n   *    - 'default'\n   *    - 'dark-content'\n   */\n  setStyle: (statusBarStyle?: string): void => {\n    RCTStatusBarManagerCompat.setStyle(statusBarStyle);\n  },\n  setHidden: (hidden: boolean): void => {\n    RCTStatusBarManagerCompat.setHidden(hidden);\n  },\n};\n\n// Define a function to apply the monkey patch\nexport const applyMonkeyPatch = () => {\n  Object.assign(NativeAndroidManager.default, ModifiedNativeAndroidManager);\n};\n\n// Define a function to revert changes back to the original state\nexport const revertMonkeyPatch = () => {\n  Object.assign(NativeAndroidManager.default, OriginalNativeAndroidManager);\n};\n"],"mappings":"AAAA;AACA,OAAO,KAAKA,oBAAoB,MAAM,2EAA2E;AAEjH,MAAMC,yBAAyB;AAC7B;AACAC,OAAO,CAAC,sCAAsC,CAAC,CAACC,OAAO;;AAEzD;AACA,MAAMC,4BAA4B,GAAG;EAAE,GAAGJ,oBAAoB,CAACG;AAAQ,CAAC;;AAExE;AACA;AACA;AACA;AACA,MAAME,4BAA4B,GAAG;EACnC,GAAGL,oBAAoB,CAACG,OAAO;EAAE;EACjCG,QAAQ,EAAEA,CAACC,KAAa,EAAEC,QAAiB,KAAW;IACpDP,yBAAyB,CAACK,QAAQ,CAACC,KAAK,EAAEC,QAAQ,CAAC;EACrD,CAAC;EACDC,cAAc,EAAGC,WAAoB,IAAW;IAC9CT,yBAAyB,CAACQ,cAAc,CAACC,WAAW,CAAC;EACvD,CAAC;EACD;AACF;AACA;AACA;AACA;EACEC,QAAQ,EAAGC,cAAuB,IAAW;IAC3CX,yBAAyB,CAACU,QAAQ,CAACC,cAAc,CAAC;EACpD,CAAC;EACDC,SAAS,EAAGC,MAAe,IAAW;IACpCb,yBAAyB,CAACY,SAAS,CAACC,MAAM,CAAC;EAC7C;AACF,CAAC;;AAED;AACA,OAAO,MAAMC,gBAAgB,GAAGA,CAAA,KAAM;EACpCC,MAAM,CAACC,MAAM,CAACjB,oBAAoB,CAACG,OAAO,EAAEE,4BAA4B,CAAC;AAC3E,CAAC;;AAED;AACA,OAAO,MAAMa,iBAAiB,GAAGA,CAAA,KAAM;EACrCF,MAAM,CAACC,MAAM,CAACjB,oBAAoB,CAACG,OAAO,EAAEC,4BAA4B,CAAC;AAC3E,CAAC","ignoreList":[]}
+{"version":3,"names":["NativeAndroidManager","RCTStatusBarManagerCompat","require","default","OriginalNativeAndroidManager","ModifiedNativeAndroidManager","setColor","color","animated","setTranslucent","translucent","setStyle","statusBarStyle","setHidden","hidden","applyMonkeyPatch","Object","assign","revertMonkeyPatch"],"sources":["monkey-patch.android.ts"],"sourcesContent":["// @ts-expect-error because there is no corresponding type definition\nimport * as NativeAndroidManager from \"react-native/Libraries/Components/StatusBar/NativeStatusBarManagerAndroid\";\n\nconst RCTStatusBarManagerCompat =\n  // eslint-disable-next-line @typescript-eslint/no-var-requires\n  require(\"./specs/NativeStatusBarManagerCompat\").default;\n\n// Copy original default manager to keep its original state and methods\nconst OriginalNativeAndroidManager = { ...NativeAndroidManager.default };\n\n// Create a new object that modifies the necessary methods\n// On Android < 11 RN uses legacy API which breaks EdgeToEdge mode in RN, so\n// in order to use library on all available platforms we have to monkey patch\n// default RN implementation and use modern `WindowInsetsControllerCompat`.\nconst ModifiedNativeAndroidManager = {\n  ...NativeAndroidManager.default, // Spread original properties to keep existing functionality\n  setColor: (color: number, animated: boolean): void => {\n    RCTStatusBarManagerCompat.setColor(color, animated);\n  },\n  setTranslucent: (translucent: boolean): void => {\n    RCTStatusBarManagerCompat.setTranslucent(translucent);\n  },\n  setStyle: (\n    statusBarStyle?: \"default\" | \"dark-content\" | \"light-content\",\n  ): void => {\n    RCTStatusBarManagerCompat.setStyle(statusBarStyle);\n  },\n  setHidden: (hidden: boolean): void => {\n    RCTStatusBarManagerCompat.setHidden(hidden);\n  },\n};\n\n// Define a function to apply the monkey patch\nexport const applyMonkeyPatch = () => {\n  Object.assign(NativeAndroidManager.default, ModifiedNativeAndroidManager);\n};\n\n// Define a function to revert changes back to the original state\nexport const revertMonkeyPatch = () => {\n  Object.assign(NativeAndroidManager.default, OriginalNativeAndroidManager);\n};\n"],"mappings":"AAAA;AACA,OAAO,KAAKA,oBAAoB,MAAM,2EAA2E;AAEjH,MAAMC,yBAAyB;AAC7B;AACAC,OAAO,CAAC,sCAAsC,CAAC,CAACC,OAAO;;AAEzD;AACA,MAAMC,4BAA4B,GAAG;EAAE,GAAGJ,oBAAoB,CAACG;AAAQ,CAAC;;AAExE;AACA;AACA;AACA;AACA,MAAME,4BAA4B,GAAG;EACnC,GAAGL,oBAAoB,CAACG,OAAO;EAAE;EACjCG,QAAQ,EAAEA,CAACC,KAAa,EAAEC,QAAiB,KAAW;IACpDP,yBAAyB,CAACK,QAAQ,CAACC,KAAK,EAAEC,QAAQ,CAAC;EACrD,CAAC;EACDC,cAAc,EAAGC,WAAoB,IAAW;IAC9CT,yBAAyB,CAACQ,cAAc,CAACC,WAAW,CAAC;EACvD,CAAC;EACDC,QAAQ,EACNC,cAA6D,IACpD;IACTX,yBAAyB,CAACU,QAAQ,CAACC,cAAc,CAAC;EACpD,CAAC;EACDC,SAAS,EAAGC,MAAe,IAAW;IACpCb,yBAAyB,CAACY,SAAS,CAACC,MAAM,CAAC;EAC7C;AACF,CAAC;;AAED;AACA,OAAO,MAAMC,gBAAgB,GAAGA,CAAA,KAAM;EACpCC,MAAM,CAACC,MAAM,CAACjB,oBAAoB,CAACG,OAAO,EAAEE,4BAA4B,CAAC;AAC3E,CAAC;;AAED;AACA,OAAO,MAAMa,iBAAiB,GAAGA,CAAA,KAAM;EACrCF,MAAM,CAACC,MAAM,CAACjB,oBAAoB,CAACG,OAAO,EAAEC,4BAA4B,CAAC;AAC3E,CAAC","ignoreList":[]}

package/lib/module/types/hooks.js

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

package/lib/module/types/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["hooks.ts"],"sourcesContent":["import type { NativeSyntheticEvent, ViewProps } from \"react-native\";\n\n// DirectEventHandler events declaration\nexport type NativeEvent = {\n  /** A value between `0` and `1` indicating keyboard position, where `0` means keyboard is closed and `1` means keyboard is fully visible. */\n  progress: number;\n  /** Height of the keyboard. */\n  height: number;\n  /** Duration of the keyboard animation. */\n  duration: number;\n  /** Tag of the focused `TextInput`. */\n  target: number;\n};\nexport type FocusedInputLayoutChangedEvent = {\n  /** Tag of the focused `TextInput`. */\n  target: number;\n  /** Tag of the parent `ScrollView`. */\n  parentScrollViewTarget: number;\n  layout: {\n    /** X coordinate of the focused `TextInput`. */\n    x: number;\n    /** Y coordinate of the focused `TextInput`. */\n    y: number;\n    /** Width of the focused `TextInput`. */\n    width: number;\n    /** Height of the focused `TextInput`. */\n    height: number;\n    /** X coordinate of the focused `TextInput` relative to the screen. */\n    absoluteX: number;\n    /** Y coordinate of the focused `TextInput` relative to the screen. */\n    absoluteY: number;\n  };\n};\nexport type FocusedInputTextChangedEvent = {\n  /** Text that user typed in the focused `TextInput`. */\n  text: string;\n};\nexport type FocusedInputSelectionChangedEvent = {\n  /** Tag of the focused `TextInput`. */\n  target: number;\n  selection: {\n    /** Start of the selection. Represents top-left point of rectangle. */\n    start: {\n      /** X coordinate of the selection start (relative to the `TextInput`). */\n      x: number;\n      /** Y coordinate of the selection start (relative to the `TextInput`). */\n      y: number;\n      /** The start of selection. */\n      position: number;\n    };\n    /** End of the selection. Represents bottom-right point of rectangle. */\n    end: {\n      /** X coordinate of the selection end (relative to the `TextInput`). */\n      x: number;\n      /** Y coordinate of the selection end (relative to the `TextInput`). */\n      y: number;\n      /** The end of selection. */\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\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  /**\n   * A callback that gets invoked when keyboard starts its movement.\n   * The event contains DESTINATION values.\n   *\n   * @example\n   * ```ts\n   * onStart: (e) => {\n   *   \"worklet\";\n   *\n   *   const willKeyboardAppear = e.progress === 1;\n   * }\n   * ```\n   */\n  onStart: (e: NativeEvent) => void;\n  /**\n   * A callback that gets involved every frame when keyboard changes its position.\n   *\n   * @example\n   * ```ts\n   * onMove: (e) => {\n   *   \"worklet\";\n   *\n   *   const keyboardHeight = e.height;\n   * }\n   */\n  onMove: (e: NativeEvent) => void;\n  /**\n   * A callback that gets invoked when keyboard finished its movement.\n   *\n   * @example\n   * ```ts\n   * onEnd: (e) => {\n   *   \"worklet\";\n   *\n   *   const isKeyboardShown = e.progress === 1;\n   * }\n   * ```\n   */\n  onEnd: (e: NativeEvent) => void;\n  /**\n   * A callback that gets invoked every frame when keyboard changes its position due to interactive dismissal.\n   *\n   * @example\n   * ```ts\n   * onInteractive: (e) => {\n   *   \"worklet\";\n   *\n   *   const keyboardHeight = e.height;\n   * }\n   */\n  onInteractive: (e: NativeEvent) => void;\n}>;\nexport type KeyboardHandlers = Handlers<KeyboardHandler>;\nexport type FocusedInputHandler = Partial<{\n  /** A callback that gets invoked every time when the text changes in focused input. */\n  onChangeText: (e: FocusedInputTextChangedEvent) => void;\n  /** A callback that gets invoked every time when the selection (cursor) coordinates change in focused input. */\n  onSelectionChange: (e: FocusedInputSelectionChangedEvent) => void;\n}>;\nexport type FocusedInputHandlers = Handlers<FocusedInputHandler>;\n"],"mappings":"","ignoreList":[]}

package/lib/module/types/index.js

@@ -0,0 +1,5 @@
+export * from "./hooks";
+export * from "./views";
+export * from "./module";
+export * from "./internal";
+//# sourceMappingURL=index.js.map

package/lib/module/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./hooks\";\nexport * from \"./views\";\nexport * from \"./module\";\nexport * from \"./internal\";\n"],"mappings":"AAAA,cAAc,SAAS;AACvB,cAAc,SAAS;AACvB,cAAc,UAAU;AACxB,cAAc,YAAY","ignoreList":[]}

package/lib/module/types/internal.js

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

package/lib/module/types/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["internal.ts"],"sourcesContent":["import type { EmitterSubscription } from \"react-native\";\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"],"mappings":"","ignoreList":[]}

package/lib/module/types/module.js

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

package/lib/module/types/module.js.map

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

package/lib/module/types/views.js

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

package/lib/module/types/views.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["views.ts"],"sourcesContent":["import type { PropsWithChildren } from \"react\";\nimport type { ViewProps } from \"react-native\";\n\nexport type KeyboardGestureAreaProps = {\n  /**\n   * Determines how the keyboard position will be controlled:\n   * - `ios` - keyboard will be following finger only when finger touches keyboard\n   * - `linear` - keyboard will be following finger position linearly.\n   *\n   * @platform android\n   */\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   * @platform android\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   * @platform android\n   */\n  enableSwipeToDismiss?: boolean;\n  /**\n   * Extra distance to the keyboard.\n   */\n  offset?: number;\n  /**\n   * A corresponding `nativeID` value from the associated `TextInput` (a string that links the `KeyboardGestureArea` to one or more `TextInput` components).\n   * 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`\n   * will receive offset behavior.\n   *\n   * @platform ios\n   */\n  textInputNativeID?: string;\n} & ViewProps;\nexport type OverKeyboardViewProps = PropsWithChildren<{\n  /**\n   * 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.\n   */\n  visible: boolean;\n}>;\n"],"mappings":"","ignoreList":[]}

package/lib/module/views/OverKeyboardView/index.js

@@ -2,10 +2,24 @@ import React, { useMemo } from "react";
 import { Platform, StyleSheet, View } from "react-native";
 import { RCTOverKeyboardView } from "../../bindings";
 import { useWindowDimensions } from "../../hooks";
-const OverKeyboardView = ({
-  children,
-  visible
-}) => {
+/**
+ * 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 => {
+  const {
+    children,
+    visible
+  } = props;
   const {
     height,
     width

package/lib/module/views/OverKeyboardView/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["React","useMemo","Platform","StyleSheet","View","RCTOverKeyboardView","useWindowDimensions","OverKeyboardView","children","visible","height","width","inner","style","styles","absolute","OS","undefined","stretch","createElement","collapsable","create","position","top","bottom","left","right"],"sources":["index.tsx"],"sourcesContent":["import React, { useMemo } from \"react\";\nimport { Platform, StyleSheet, View } from \"react-native\";\n\nimport { RCTOverKeyboardView } from \"../../bindings\";\nimport { useWindowDimensions } from \"../../hooks\";\n\nimport type { OverKeyboardViewProps } from \"../../types\";\nimport type { PropsWithChildren } from \"react\";\n\nconst OverKeyboardView = ({\n  children,\n  visible,\n}: PropsWithChildren<OverKeyboardViewProps>) => {\n  const { height, width } = useWindowDimensions();\n  const inner = useMemo(() => ({ height, width }), [height, width]);\n  const style = useMemo(\n    () => [\n      styles.absolute,\n      // On iOS - stretch view to full window dimensions to make yoga work\n      Platform.OS === \"ios\" ? inner : undefined,\n      // On Android - we are laid out by ShadowNode, so just stretch to full container\n      Platform.OS === \"android\" ? styles.stretch : undefined,\n    ],\n    [inner],\n  );\n\n  return (\n    <RCTOverKeyboardView visible={visible}>\n      {/* `OverKeyboardView` should always have a single child */}\n      <View collapsable={false} style={style}>\n        {/* Match RN behavior and trigger mount/unmount when visibility changes */}\n        {visible && children}\n      </View>\n    </RCTOverKeyboardView>\n  );\n};\n\nconst styles = StyleSheet.create({\n  absolute: {\n    position: \"absolute\",\n  },\n  stretch: {\n    top: 0,\n    bottom: 0,\n    left: 0,\n    right: 0,\n  },\n});\n\nexport default OverKeyboardView;\n"],"mappings":"AAAA,OAAOA,KAAK,IAAIC,OAAO,QAAQ,OAAO;AACtC,SAASC,QAAQ,EAAEC,UAAU,EAAEC,IAAI,QAAQ,cAAc;AAEzD,SAASC,mBAAmB,QAAQ,gBAAgB;AACpD,SAASC,mBAAmB,QAAQ,aAAa;AAKjD,MAAMC,gBAAgB,GAAGA,CAAC;EACxBC,QAAQ;EACRC;AACwC,CAAC,KAAK;EAC9C,MAAM;IAAEC,MAAM;IAAEC;EAAM,CAAC,GAAGL,mBAAmB,CAAC,CAAC;EAC/C,MAAMM,KAAK,GAAGX,OAAO,CAAC,OAAO;IAAES,MAAM;IAAEC;EAAM,CAAC,CAAC,EAAE,CAACD,MAAM,EAAEC,KAAK,CAAC,CAAC;EACjE,MAAME,KAAK,GAAGZ,OAAO,CACnB,MAAM,CACJa,MAAM,CAACC,QAAQ;EACf;EACAb,QAAQ,CAACc,EAAE,KAAK,KAAK,GAAGJ,KAAK,GAAGK,SAAS;EACzC;EACAf,QAAQ,CAACc,EAAE,KAAK,SAAS,GAAGF,MAAM,CAACI,OAAO,GAAGD,SAAS,CACvD,EACD,CAACL,KAAK,CACR,CAAC;EAED,oBACEZ,KAAA,CAAAmB,aAAA,CAACd,mBAAmB;IAACI,OAAO,EAAEA;EAAQ,gBAEpCT,KAAA,CAAAmB,aAAA,CAACf,IAAI;IAACgB,WAAW,EAAE,KAAM;IAACP,KAAK,EAAEA;EAAM,GAEpCJ,OAAO,IAAID,QACR,CACa,CAAC;AAE1B,CAAC;AAED,MAAMM,MAAM,GAAGX,UAAU,CAACkB,MAAM,CAAC;EAC/BN,QAAQ,EAAE;IACRO,QAAQ,EAAE;EACZ,CAAC;EACDJ,OAAO,EAAE;IACPK,GAAG,EAAE,CAAC;IACNC,MAAM,EAAE,CAAC;IACTC,IAAI,EAAE,CAAC;IACPC,KAAK,EAAE;EACT;AACF,CAAC,CAAC;AAEF,eAAenB,gBAAgB","ignoreList":[]}
+{"version":3,"names":["React","useMemo","Platform","StyleSheet","View","RCTOverKeyboardView","useWindowDimensions","OverKeyboardView","props","children","visible","height","width","inner","style","styles","absolute","OS","undefined","stretch","createElement","collapsable","create","position","top","bottom","left","right"],"sources":["index.tsx"],"sourcesContent":["import React, { useMemo } from \"react\";\nimport { Platform, StyleSheet, View } from \"react-native\";\n\nimport { RCTOverKeyboardView } from \"../../bindings\";\nimport { useWindowDimensions } from \"../../hooks\";\n\nimport type { OverKeyboardViewProps } from \"../../types\";\nimport type { PropsWithChildren } from \"react\";\n\n/**\n * A view component that renders its children over the keyboard without closing the keyboard.\n * Acts similar to modal, but doesn't close the keyboard when it's visible.\n *\n * @param props - Component props.\n * @returns A view component that renders over the keyboard.\n * @example\n * ```tsx\n * <OverKeyboardView visible={true}>\n *   <Text>This will appear over the keyboard</Text>\n * </OverKeyboardView>\n * ```\n */\nconst OverKeyboardView = (props: PropsWithChildren<OverKeyboardViewProps>) => {\n  const { children, visible } = props;\n  const { height, width } = useWindowDimensions();\n  const inner = useMemo(() => ({ height, width }), [height, width]);\n  const style = useMemo(\n    () => [\n      styles.absolute,\n      // On iOS - stretch view to full window dimensions to make yoga work\n      Platform.OS === \"ios\" ? inner : undefined,\n      // On Android - we are laid out by ShadowNode, so just stretch to full container\n      Platform.OS === \"android\" ? styles.stretch : undefined,\n    ],\n    [inner],\n  );\n\n  return (\n    <RCTOverKeyboardView visible={visible}>\n      {/* `OverKeyboardView` should always have a single child */}\n      <View collapsable={false} style={style}>\n        {/* Match RN behavior and trigger mount/unmount when visibility changes */}\n        {visible && children}\n      </View>\n    </RCTOverKeyboardView>\n  );\n};\n\nconst styles = StyleSheet.create({\n  absolute: {\n    position: \"absolute\",\n  },\n  stretch: {\n    top: 0,\n    bottom: 0,\n    left: 0,\n    right: 0,\n  },\n});\n\nexport default OverKeyboardView;\n"],"mappings":"AAAA,OAAOA,KAAK,IAAIC,OAAO,QAAQ,OAAO;AACtC,SAASC,QAAQ,EAAEC,UAAU,EAAEC,IAAI,QAAQ,cAAc;AAEzD,SAASC,mBAAmB,QAAQ,gBAAgB;AACpD,SAASC,mBAAmB,QAAQ,aAAa;AAKjD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,gBAAgB,GAAIC,KAA+C,IAAK;EAC5E,MAAM;IAAEC,QAAQ;IAAEC;EAAQ,CAAC,GAAGF,KAAK;EACnC,MAAM;IAAEG,MAAM;IAAEC;EAAM,CAAC,GAAGN,mBAAmB,CAAC,CAAC;EAC/C,MAAMO,KAAK,GAAGZ,OAAO,CAAC,OAAO;IAAEU,MAAM;IAAEC;EAAM,CAAC,CAAC,EAAE,CAACD,MAAM,EAAEC,KAAK,CAAC,CAAC;EACjE,MAAME,KAAK,GAAGb,OAAO,CACnB,MAAM,CACJc,MAAM,CAACC,QAAQ;EACf;EACAd,QAAQ,CAACe,EAAE,KAAK,KAAK,GAAGJ,KAAK,GAAGK,SAAS;EACzC;EACAhB,QAAQ,CAACe,EAAE,KAAK,SAAS,GAAGF,MAAM,CAACI,OAAO,GAAGD,SAAS,CACvD,EACD,CAACL,KAAK,CACR,CAAC;EAED,oBACEb,KAAA,CAAAoB,aAAA,CAACf,mBAAmB;IAACK,OAAO,EAAEA;EAAQ,gBAEpCV,KAAA,CAAAoB,aAAA,CAAChB,IAAI;IAACiB,WAAW,EAAE,KAAM;IAACP,KAAK,EAAEA;EAAM,GAEpCJ,OAAO,IAAID,QACR,CACa,CAAC;AAE1B,CAAC;AAED,MAAMM,MAAM,GAAGZ,UAAU,CAACmB,MAAM,CAAC;EAC/BN,QAAQ,EAAE;IACRO,QAAQ,EAAE;EACZ,CAAC;EACDJ,OAAO,EAAE;IACPK,GAAG,EAAE,CAAC;IACNC,MAAM,EAAE,CAAC;IACTC,IAAI,EAAE,CAAC;IACPC,KAAK,EAAE;EACT;AACF,CAAC,CAAC;AAEF,eAAepB,gBAAgB","ignoreList":[]}

package/lib/typescript/animated.d.ts

@@ -7,33 +7,47 @@ type KeyboardProviderProps = {
      * or `StatusBar` component from `react-native`, you can ignore it.
      * Defaults to `false`.
      *
-     * @see https://github.com/kirillzyusko/react-native-keyboard-controller/issues/14
      * @platform android
+     * @see https://github.com/kirillzyusko/react-native-keyboard-controller/issues/14
      */
     statusBarTranslucent?: boolean;
     /**
      * Set the value to `true`, if you use translucent navigation bar on Android.
      * Defaults to `false`.
      *
-     * @see https://github.com/kirillzyusko/react-native-keyboard-controller/issues/119
      * @platform android
+     * @see https://github.com/kirillzyusko/react-native-keyboard-controller/issues/119
      */
     navigationBarTranslucent?: boolean;
     /**
      * A boolean property indicating whether to keep edge-to-edge mode always enabled (even when you disable the module).
      * Defaults to `false`.
      *
-     * @see https://github.com/kirillzyusko/react-native-keyboard-controller/issues/592
      * @platform android
+     * @see https://github.com/kirillzyusko/react-native-keyboard-controller/issues/592
      */
     preserveEdgeToEdge?: boolean;
     /**
-     * A boolean prop indicating whether the module is enabled. It indicate only initial state,
-     * i. e. if you try to change this prop after component mount it will not have any effect.
+     * A boolean prop indicating whether the module is enabled. It indicate only initial state
+     * (if you try to change this prop after component mount it will not have any effect).
      * To change the property in runtime use `useKeyboardController` hook and `setEnabled` method.
      * Defaults to `true`.
      */
     enabled?: boolean;
 };
-export declare const KeyboardProvider: ({ children, statusBarTranslucent, navigationBarTranslucent, preserveEdgeToEdge, enabled: initiallyEnabled, }: KeyboardProviderProps) => React.JSX.Element;
+/**
+ * A component that wrap your app. Under the hood it works with {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller-view|KeyboardControllerView} to receive events during keyboard movements,
+ * maps these events to `Animated`/`Reanimated` values and store them in context.
+ *
+ * @param props - Provider props, such as `statusBarTranslucent`, `navigationBarTranslucent`, etc.
+ * @returns A component that should be mounted in root of your App layout.
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-provider|Documentation} page for more details.
+ * @example
+ * ```tsx
+ * <KeyboardProvider>
+ *   <NavigationContainer />
+ * </KeyboardProvider>
+ * ```
+ */
+export declare const KeyboardProvider: (props: KeyboardProviderProps) => React.JSX.Element;
 export {};

package/lib/typescript/bindings.d.ts

@@ -1,5 +1,14 @@
 import type { FocusedInputEventsModule, KeyboardControllerNativeModule, KeyboardControllerProps, KeyboardEventsModule, KeyboardGestureAreaProps, OverKeyboardViewProps, WindowDimensionsEventsModule } from "./types";
 export declare const KeyboardControllerNative: KeyboardControllerNativeModule;
+/**
+ * An event emitter that provides a way to subscribe to next keyboard events:
+ * - `keyboardWillShow`;
+ * - `keyboardDidShow`;
+ * - `keyboardWillHide`;
+ * - `keyboardDidHide`.
+ *
+ * Use `addListener` function to add your event listener for a specific keyboard event.
+ */
 export declare const KeyboardEvents: KeyboardEventsModule;
 /**
  * This API is not documented, it's for internal usage only (for now), and is a subject to potential breaking changes in future.
@@ -7,6 +16,16 @@ export declare const KeyboardEvents: KeyboardEventsModule;
  */
 export declare const FocusedInputEvents: FocusedInputEventsModule;
 export declare const WindowDimensionsEvents: WindowDimensionsEventsModule;
+/**
+ * A view that sends events whenever keyboard or focused events are happening.
+ *
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller-view|Documentation} page for more details.
+ */
 export declare const KeyboardControllerView: React.FC<KeyboardControllerProps>;
+/**
+ * A view that defines a region on the screen, where gestures will control the keyboard position.
+ *
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-gesture-area|Documentation} page for more details.
+ */
 export declare const KeyboardGestureArea: React.FC<KeyboardGestureAreaProps>;
 export declare const RCTOverKeyboardView: React.FC<OverKeyboardViewProps>;

package/lib/typescript/components/KeyboardAvoidingView/index.d.ts

@@ -33,8 +33,17 @@ export type KeyboardAvoidingViewProps = KeyboardAvoidingViewBaseProps & ({
     contentContainerStyle?: never;
 });
 /**
- * View that moves out of the way when the keyboard appears by automatically
- * adjusting its height, position, or bottom padding.
+ * A View component that automatically adjusts its height, position, or bottom padding
+ * when the keyboard appears to ensure that the content remains visible.
+ *
+ * @returns A View component that adjusts to keyboard visibility.
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/components/keyboard-avoiding-view|Documentation} page for more details.
+ * @example
+ * ```tsx
+ * <KeyboardAvoidingView behavior="padding">
+ *   <TextInput />
+ * </KeyboardAvoidingView>
+ * ```
  */
 declare const KeyboardAvoidingView: React.ForwardRefExoticComponent<React.PropsWithChildren<KeyboardAvoidingViewProps> & React.RefAttributes<View>>;
 export default KeyboardAvoidingView;

package/lib/typescript/components/KeyboardAwareScrollView/index.d.ts

@@ -5,23 +5,40 @@ export type KeyboardAwareScrollViewProps = {
     bottomOffset?: number;
     /** Prevents automatic scrolling of the `ScrollView` when the keyboard gets hidden, maintaining the current screen position. Default is `false`. */
     disableScrollOnKeyboardHide?: boolean;
-    /** Controls whether this `KeyboardAwareScrollView` instance should take effect. Default is `true` */
+    /** Controls whether this `KeyboardAwareScrollView` instance should take effect. Default is `true`. */
     enabled?: boolean;
-    /** Adjusting the bottom spacing of KeyboardAwareScrollView. Default is `0` */
+    /** Adjusting the bottom spacing of KeyboardAwareScrollView. Default is `0`. */
     extraKeyboardSpace?: number;
-    /** Custom component for `ScrollView`. Default is `ScrollView` */
+    /** Custom component for `ScrollView`. Default is `ScrollView`. */
     ScrollViewComponent?: React.ComponentType<ScrollViewProps>;
 } & ScrollViewProps;
+/**
+ * A ScrollView component that automatically handles keyboard appearance and disappearance
+ * by adjusting its content position to ensure the focused input remains visible.
+ *
+ * The component uses a sophisticated animation system to smoothly handle keyboard transitions
+ * and maintain proper scroll position during keyboard interactions.
+ *
+ * @returns A ScrollView component that handles keyboard interactions.
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/components/keyboard-aware-scroll-view|Documentation} page for more details.
+ * @example
+ * ```tsx
+ * <KeyboardAwareScrollView bottomOffset={20}>
+ *   <TextInput placeholder="Enter text" />
+ *   <TextInput placeholder="Another input" />
+ * </KeyboardAwareScrollView>
+ * ```
+ */
 declare const KeyboardAwareScrollView: React.ForwardRefExoticComponent<{
     /** The distance between keyboard and focused `TextInput` when keyboard is shown. Default is `0`. */
     bottomOffset?: number;
     /** Prevents automatic scrolling of the `ScrollView` when the keyboard gets hidden, maintaining the current screen position. Default is `false`. */
     disableScrollOnKeyboardHide?: boolean;
-    /** Controls whether this `KeyboardAwareScrollView` instance should take effect. Default is `true` */
+    /** Controls whether this `KeyboardAwareScrollView` instance should take effect. Default is `true`. */
     enabled?: boolean;
-    /** Adjusting the bottom spacing of KeyboardAwareScrollView. Default is `0` */
+    /** Adjusting the bottom spacing of KeyboardAwareScrollView. Default is `0`. */
     extraKeyboardSpace?: number;
-    /** Custom component for `ScrollView`. Default is `ScrollView` */
+    /** Custom component for `ScrollView`. Default is `ScrollView`. */
     ScrollViewComponent?: React.ComponentType<ScrollViewProps>;
 } & ScrollViewProps & {
     children?: React.ReactNode | undefined;

package/lib/typescript/components/KeyboardAwareScrollView/useSmoothKeyboardHandler.d.ts

@@ -1,6 +1,22 @@
 import { useKeyboardHandler } from "../../hooks";
 /**
  * Hook that uses default transitions for iOS and Android > 11, and uses
- * custom interpolation on Android < 11 to achieve more smooth animation
+ * custom interpolation on Android < 11 to achieve more smooth animation.
+ *
+ * @param handler - Object containing keyboard event handlers.
+ * @param [deps] - Dependencies array for the effect.
+ * @example
+ * ```ts
+ * useSmoothKeyboardHandler(
+ *   {
+ *     onStart: (e) => {
+ *       "worklet";
+ *
+ *       // your handler for keyboard start
+ *     },
+ *   },
+ *   [],
+ * );
+ * ```
  */
 export declare const useSmoothKeyboardHandler: typeof useKeyboardHandler;

package/lib/typescript/components/KeyboardStickyView/index.d.ts

@@ -14,9 +14,22 @@ export type KeyboardStickyViewProps = {
          */
         opened?: number;
     };
-    /** Controls whether this `KeyboardStickyView` instance should take effect. Default is `true` */
+    /** Controls whether this `KeyboardStickyView` instance should take effect. Default is `true`. */
     enabled?: boolean;
 } & ViewProps;
+/**
+ * A View component that sticks to the keyboard and moves with it when it appears or disappears.
+ * The view can be configured with custom offsets for both closed and open keyboard states.
+ *
+ * @returns An animated View component that sticks to the keyboard.
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/components/keyboard-sticky-view|Documentation} page for more details.
+ * @example
+ * ```tsx
+ * <KeyboardStickyView offset={{ closed: 0, opened: 20 }}>
+ *   <Button title="Submit" />
+ * </KeyboardStickyView>
+ * ```
+ */
 declare const KeyboardStickyView: React.ForwardRefExoticComponent<{
     /**
      * Specify additional offset to the view for given keyboard state.
@@ -31,7 +44,7 @@ declare const KeyboardStickyView: React.ForwardRefExoticComponent<{
          */
         opened?: number;
     };
-    /** Controls whether this `KeyboardStickyView` instance should take effect. Default is `true` */
+    /** Controls whether this `KeyboardStickyView` instance should take effect. Default is `true`. */
     enabled?: boolean;
 } & ViewProps & {
     children?: React.ReactNode | undefined;

package/lib/typescript/components/KeyboardToolbar/index.d.ts

@@ -46,11 +46,22 @@ export type KeyboardToolbarProps = Omit<ViewProps, "style" | "testID" | "childre
      * A value for container opacity in hexadecimal format (e.g. `ff`). Default value is `ff`.
      */
     opacity?: HEX;
+    /**
+     * A object containing `left`/`right` properties. Used to specify proper container padding in landscape mode.
+     */
     insets?: SafeAreaInsets;
 } & Pick<KeyboardStickyViewProps, "offset" | "enabled">;
 /**
- * `KeyboardToolbar` is a component that is shown above the keyboard with `Prev`/`Next` and
- * `Done` buttons.
+ * `KeyboardToolbar` is a component that is shown above the keyboard with `Prev`/`Next` buttons from left and
+ * `Done` button from the right (to dismiss the keyboard). Allows to add customizable content (yours UI elements) in the middle.
+ *
+ * @param props - Component props.
+ * @returns A component that is shown above the keyboard with `Prev`/`Next` and `Done` buttons.
+ * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/components/keyboard-toolbar|Documentation} page for more details.
+ * @example
+ * ```tsx
+ * <KeyboardToolbar doneText="Close" />
+ * ```
  */
 declare const KeyboardToolbar: React.FC<KeyboardToolbarProps>;
 export { colors as DefaultKeyboardToolbarTheme };

package/lib/typescript/context.d.ts

@@ -3,21 +3,53 @@ import type { FocusedInputHandler, FocusedInputLayoutChangedEvent, KeyboardHandl
 import type React from "react";
 import type { SharedValue } from "react-native-reanimated";
 export type AnimatedContext = {
+    /**
+     * A value between `0` and `1` indicating keyboard position, where `0` means keyboard is closed and `1` means keyboard is fully visible.
+     * Represented as `Animated.Value`.
+     */
     progress: Animated.Value;
+    /** Height of the keyboard. Represented as `Animated.Value`. */
     height: Animated.AnimatedMultiplication<number>;
 };
 export type ReanimatedContext = {
+    /**
+     * A value between `0` and `1` indicating keyboard position, where `0` means keyboard is closed and `1` means keyboard is fully visible.
+     * Represented as `SharedValue`.
+     */
     progress: SharedValue<number>;
+    /** Height of the keyboard. Represented as `SharedValue`. */
     height: SharedValue<number>;
 };
 export type KeyboardAnimationContext = {
+    /** Whether KeyboardController library is active or not. */
     enabled: boolean;
+    /** Object that stores animated values that reflect the keyboard’s current position and movement. */
     animated: AnimatedContext;
+    /** Object that stores reanimated values that reflect the keyboard’s current position and movement. */
     reanimated: ReanimatedContext;
+    /** Layout of the focused `TextInput` represented as `SharedValue`. */
     layout: SharedValue<FocusedInputLayoutChangedEvent | null>;
+    /** Method for setting workletized keyboard handlers. */
     setKeyboardHandlers: (handlers: KeyboardHandler) => () => void;
+    /** Method for setting workletized handlers for tracking focused input events. */
     setInputHandlers: (handlers: FocusedInputHandler) => () => void;
+    /** Method to enable/disable KeyboardController library. */
     setEnabled: React.Dispatch<React.SetStateAction<boolean>>;
 };
 export declare const KeyboardContext: React.Context<KeyboardAnimationContext>;
+/**
+ * A hook that returns a reference to {@link KeyboardAnimationContext} object.
+ *
+ * @returns Object {@link KeyboardAnimationContext|containing} keyboard-controller context.
+ * @example
+ * ```ts
+ *   const context = useKeyboardContext();
+ *
+ *   useLayoutEffect(() => {
+ *     const cleanup = context.setInputHandlers(handler);
+ *
+ *     return () => cleanup();
+ *   }, deps);
+ * ```
+ */
 export declare const useKeyboardContext: () => KeyboardAnimationContext;