react-simplikit 0.0.53 → 0.2.0

package/dist/mobile/utils/getSafeAreaInset/getSafeAreaInset.mjs

@@ -0,0 +1,58 @@
+"use client";
+import { isServer } from "../isServer/isServer.mjs";
+//#region src/mobile/utils/getSafeAreaInset/getSafeAreaInset.ts
+/**
+* @description
+* `getSafeAreaInset` is a utility function that returns all safe area insets in pixels as an object.
+*
+* This function reads the CSS `env(safe-area-inset-*)` values by creating
+* a temporary DOM element and reading its computed style.
+*
+* Safe area insets account for device-specific UI elements:
+* - **top**: Notch, Dynamic Island, or status bar
+* - **bottom**: Home indicator on Face ID devices
+* - **left/right**: Rounded corners in landscape mode
+*
+* Typical values (iPhone with Face ID, portrait mode):
+* - top: 47-59px (notch/Dynamic Island)
+* - bottom: 34px (home indicator)
+* - left/right: 0px
+*
+* @returns {SafeAreaInset} Object containing safe area insets for all four sides, or all 0 if not available.
+* - top `number` - Top safe area inset in pixels;
+* - bottom `number` - Bottom safe area inset in pixels;
+* - left `number` - Left safe area inset in pixels;
+* - right `number` - Right safe area inset in pixels;
+*
+* @example
+* const { top, bottom, left, right } = getSafeAreaInset();
+*
+* header.style.paddingTop = `${top}px`;
+* footer.style.paddingBottom = `${bottom}px`;
+*/
+function getSafeAreaInset() {
+	if (isServer()) return {
+		top: 0,
+		bottom: 0,
+		left: 0,
+		right: 0
+	};
+	const div = document.createElement("div");
+	div.style.position = "fixed";
+	div.style.setProperty("padding-top", "env(safe-area-inset-top)");
+	div.style.setProperty("padding-bottom", "env(safe-area-inset-bottom)");
+	div.style.setProperty("padding-left", "env(safe-area-inset-left)");
+	div.style.setProperty("padding-right", "env(safe-area-inset-right)");
+	document.body.appendChild(div);
+	const computedStyle = window.getComputedStyle(div);
+	const inset = {
+		top: parseFloat(computedStyle.getPropertyValue("padding-top")) || 0,
+		bottom: parseFloat(computedStyle.getPropertyValue("padding-bottom")) || 0,
+		left: parseFloat(computedStyle.getPropertyValue("padding-left")) || 0,
+		right: parseFloat(computedStyle.getPropertyValue("padding-right")) || 0
+	};
+	document.body.removeChild(div);
+	return inset;
+}
+//#endregion
+export { getSafeAreaInset };

package/dist/mobile/utils/isAndroid/isAndroid.cjs

@@ -0,0 +1,32 @@
+"use client";
+const require_isServer = require("../isServer/isServer.cjs");
+//#region src/mobile/utils/isAndroid/isAndroid.ts
+/**
+* @description
+* `isAndroid` is a utility function that detects whether the current device is running Android.
+*
+* Notes:
+* - All Android browsers include the token "Android" in the user agent.
+*
+* @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+*
+* @returns {boolean} `true` if the device is running Android, `false` otherwise.
+* Returns `false` on server-side rendering environments.
+*
+* @example
+* if (isAndroid()) {
+*   // Android-specific code
+*   enableAndroidOptimizations();
+* }
+*
+* @example
+* // With custom user agent
+* const isAndroidDevice = isAndroid('Mozilla/5.0 (Linux; Android 12; Pixel 6) Chrome/120');
+*/
+function isAndroid(userAgent) {
+	if (require_isServer.isServer()) return false;
+	const ua = userAgent ?? navigator.userAgent;
+	return /Android/i.test(ua);
+}
+//#endregion
+exports.isAndroid = isAndroid;

package/dist/mobile/utils/isAndroid/isAndroid.d.cts

@@ -0,0 +1,27 @@
+
+//#region src/mobile/utils/isAndroid/isAndroid.d.ts
+/**
+ * @description
+ * `isAndroid` is a utility function that detects whether the current device is running Android.
+ *
+ * Notes:
+ * - All Android browsers include the token "Android" in the user agent.
+ *
+ * @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+ *
+ * @returns {boolean} `true` if the device is running Android, `false` otherwise.
+ * Returns `false` on server-side rendering environments.
+ *
+ * @example
+ * if (isAndroid()) {
+ *   // Android-specific code
+ *   enableAndroidOptimizations();
+ * }
+ *
+ * @example
+ * // With custom user agent
+ * const isAndroidDevice = isAndroid('Mozilla/5.0 (Linux; Android 12; Pixel 6) Chrome/120');
+ */
+declare function isAndroid(userAgent?: string): boolean;
+//#endregion
+export { isAndroid };

package/dist/mobile/utils/isAndroid/isAndroid.d.mts

@@ -0,0 +1,27 @@
+
+//#region src/mobile/utils/isAndroid/isAndroid.d.ts
+/**
+ * @description
+ * `isAndroid` is a utility function that detects whether the current device is running Android.
+ *
+ * Notes:
+ * - All Android browsers include the token "Android" in the user agent.
+ *
+ * @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+ *
+ * @returns {boolean} `true` if the device is running Android, `false` otherwise.
+ * Returns `false` on server-side rendering environments.
+ *
+ * @example
+ * if (isAndroid()) {
+ *   // Android-specific code
+ *   enableAndroidOptimizations();
+ * }
+ *
+ * @example
+ * // With custom user agent
+ * const isAndroidDevice = isAndroid('Mozilla/5.0 (Linux; Android 12; Pixel 6) Chrome/120');
+ */
+declare function isAndroid(userAgent?: string): boolean;
+//#endregion
+export { isAndroid };

package/dist/mobile/utils/isAndroid/isAndroid.mjs

@@ -0,0 +1,32 @@
+"use client";
+import { isServer } from "../isServer/isServer.mjs";
+//#region src/mobile/utils/isAndroid/isAndroid.ts
+/**
+* @description
+* `isAndroid` is a utility function that detects whether the current device is running Android.
+*
+* Notes:
+* - All Android browsers include the token "Android" in the user agent.
+*
+* @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+*
+* @returns {boolean} `true` if the device is running Android, `false` otherwise.
+* Returns `false` on server-side rendering environments.
+*
+* @example
+* if (isAndroid()) {
+*   // Android-specific code
+*   enableAndroidOptimizations();
+* }
+*
+* @example
+* // With custom user agent
+* const isAndroidDevice = isAndroid('Mozilla/5.0 (Linux; Android 12; Pixel 6) Chrome/120');
+*/
+function isAndroid(userAgent) {
+	if (isServer()) return false;
+	const ua = userAgent ?? navigator.userAgent;
+	return /Android/i.test(ua);
+}
+//#endregion
+export { isAndroid };

package/dist/mobile/utils/isIOS/isIOS.cjs

@@ -0,0 +1,37 @@
+"use client";
+const require_isServer = require("../isServer/isServer.cjs");
+//#region src/mobile/utils/isIOS/isIOS.ts
+/**
+* @description
+* `isIOS` is a utility function that detects whether the current device is running iOS or iPadOS.
+*
+* Notes on platform inconsistencies:
+* - Prior to iPadOS 13, iPads reported their platform as "iPad" (or matched /iPad/ in UA).
+* - Starting from iPadOS 13, Apple changed the platform string to "MacIntel"
+*   to make websites treat iPadOS as desktop-class Safari.
+*   However, these devices still expose multi-touch capabilities.
+*
+* @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+*
+* @returns {boolean} `true` if the device is running iOS or iPadOS, `false` otherwise.
+* Returns `false` on server-side rendering environments.
+*
+* @example
+* if (isIOS()) {
+*   // iOS-specific code
+*   enableIOSOptimizations();
+* }
+*
+* @example
+* // With custom user agent
+* const isIOSDevice = isIOS('Mozilla/5.0 (iPhone; CPU iPhone OS 15_0 like Mac OS X)');
+*/
+function isIOS(userAgent) {
+	if (require_isServer.isServer()) return false;
+	const ua = userAgent ?? navigator.userAgent;
+	const platform = navigator.platform;
+	const maxTouchPoints = navigator.maxTouchPoints;
+	return /iPhone|iPad|iPod/i.test(ua) || platform === "MacIntel" && typeof maxTouchPoints === "number" && maxTouchPoints > 1;
+}
+//#endregion
+exports.isIOS = isIOS;

package/dist/mobile/utils/isIOS/isIOS.d.cts

@@ -0,0 +1,30 @@
+
+//#region src/mobile/utils/isIOS/isIOS.d.ts
+/**
+ * @description
+ * `isIOS` is a utility function that detects whether the current device is running iOS or iPadOS.
+ *
+ * Notes on platform inconsistencies:
+ * - Prior to iPadOS 13, iPads reported their platform as "iPad" (or matched /iPad/ in UA).
+ * - Starting from iPadOS 13, Apple changed the platform string to "MacIntel"
+ *   to make websites treat iPadOS as desktop-class Safari.
+ *   However, these devices still expose multi-touch capabilities.
+ *
+ * @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+ *
+ * @returns {boolean} `true` if the device is running iOS or iPadOS, `false` otherwise.
+ * Returns `false` on server-side rendering environments.
+ *
+ * @example
+ * if (isIOS()) {
+ *   // iOS-specific code
+ *   enableIOSOptimizations();
+ * }
+ *
+ * @example
+ * // With custom user agent
+ * const isIOSDevice = isIOS('Mozilla/5.0 (iPhone; CPU iPhone OS 15_0 like Mac OS X)');
+ */
+declare function isIOS(userAgent?: string): boolean;
+//#endregion
+export { isIOS };

package/dist/mobile/utils/isIOS/isIOS.d.mts

@@ -0,0 +1,30 @@
+
+//#region src/mobile/utils/isIOS/isIOS.d.ts
+/**
+ * @description
+ * `isIOS` is a utility function that detects whether the current device is running iOS or iPadOS.
+ *
+ * Notes on platform inconsistencies:
+ * - Prior to iPadOS 13, iPads reported their platform as "iPad" (or matched /iPad/ in UA).
+ * - Starting from iPadOS 13, Apple changed the platform string to "MacIntel"
+ *   to make websites treat iPadOS as desktop-class Safari.
+ *   However, these devices still expose multi-touch capabilities.
+ *
+ * @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+ *
+ * @returns {boolean} `true` if the device is running iOS or iPadOS, `false` otherwise.
+ * Returns `false` on server-side rendering environments.
+ *
+ * @example
+ * if (isIOS()) {
+ *   // iOS-specific code
+ *   enableIOSOptimizations();
+ * }
+ *
+ * @example
+ * // With custom user agent
+ * const isIOSDevice = isIOS('Mozilla/5.0 (iPhone; CPU iPhone OS 15_0 like Mac OS X)');
+ */
+declare function isIOS(userAgent?: string): boolean;
+//#endregion
+export { isIOS };

package/dist/mobile/utils/isIOS/isIOS.mjs

@@ -0,0 +1,37 @@
+"use client";
+import { isServer } from "../isServer/isServer.mjs";
+//#region src/mobile/utils/isIOS/isIOS.ts
+/**
+* @description
+* `isIOS` is a utility function that detects whether the current device is running iOS or iPadOS.
+*
+* Notes on platform inconsistencies:
+* - Prior to iPadOS 13, iPads reported their platform as "iPad" (or matched /iPad/ in UA).
+* - Starting from iPadOS 13, Apple changed the platform string to "MacIntel"
+*   to make websites treat iPadOS as desktop-class Safari.
+*   However, these devices still expose multi-touch capabilities.
+*
+* @param {string} [userAgent] - Optional user agent string to check. Defaults to `navigator.userAgent`.
+*
+* @returns {boolean} `true` if the device is running iOS or iPadOS, `false` otherwise.
+* Returns `false` on server-side rendering environments.
+*
+* @example
+* if (isIOS()) {
+*   // iOS-specific code
+*   enableIOSOptimizations();
+* }
+*
+* @example
+* // With custom user agent
+* const isIOSDevice = isIOS('Mozilla/5.0 (iPhone; CPU iPhone OS 15_0 like Mac OS X)');
+*/
+function isIOS(userAgent) {
+	if (isServer()) return false;
+	const ua = userAgent ?? navigator.userAgent;
+	const platform = navigator.platform;
+	const maxTouchPoints = navigator.maxTouchPoints;
+	return /iPhone|iPad|iPod/i.test(ua) || platform === "MacIntel" && typeof maxTouchPoints === "number" && maxTouchPoints > 1;
+}
+//#endregion
+export { isIOS };

package/dist/mobile/utils/isKeyboardVisible/isKeyboardVisible.cjs

@@ -0,0 +1,28 @@
+"use client";
+const require_getKeyboardHeight = require("../getKeyboardHeight/getKeyboardHeight.cjs");
+//#region src/mobile/utils/isKeyboardVisible/isKeyboardVisible.ts
+/**
+* @description
+* `isKeyboardVisible` is a utility function that checks whether the on-screen keyboard is currently visible.
+*
+* This function uses `getKeyboardHeight()` internally and returns `true`
+* if the keyboard height is greater than 0.
+*
+* @returns {boolean} `true` if the keyboard is visible, `false` otherwise.
+*
+* @example
+* if (isKeyboardVisible()) {
+*   console.log('Keyboard is open');
+* } else {
+*   console.log('Keyboard is closed');
+* }
+*
+* @example
+* // Conditionally show/hide elements based on keyboard visibility
+* const showFloatingButton = !isKeyboardVisible();
+*/
+function isKeyboardVisible() {
+	return require_getKeyboardHeight.getKeyboardHeight() > 0;
+}
+//#endregion
+exports.isKeyboardVisible = isKeyboardVisible;

package/dist/mobile/utils/isKeyboardVisible/isKeyboardVisible.d.cts

@@ -0,0 +1,25 @@
+
+//#region src/mobile/utils/isKeyboardVisible/isKeyboardVisible.d.ts
+/**
+ * @description
+ * `isKeyboardVisible` is a utility function that checks whether the on-screen keyboard is currently visible.
+ *
+ * This function uses `getKeyboardHeight()` internally and returns `true`
+ * if the keyboard height is greater than 0.
+ *
+ * @returns {boolean} `true` if the keyboard is visible, `false` otherwise.
+ *
+ * @example
+ * if (isKeyboardVisible()) {
+ *   console.log('Keyboard is open');
+ * } else {
+ *   console.log('Keyboard is closed');
+ * }
+ *
+ * @example
+ * // Conditionally show/hide elements based on keyboard visibility
+ * const showFloatingButton = !isKeyboardVisible();
+ */
+declare function isKeyboardVisible(): boolean;
+//#endregion
+export { isKeyboardVisible };

package/dist/mobile/utils/isKeyboardVisible/isKeyboardVisible.d.mts

@@ -0,0 +1,25 @@
+
+//#region src/mobile/utils/isKeyboardVisible/isKeyboardVisible.d.ts
+/**
+ * @description
+ * `isKeyboardVisible` is a utility function that checks whether the on-screen keyboard is currently visible.
+ *
+ * This function uses `getKeyboardHeight()` internally and returns `true`
+ * if the keyboard height is greater than 0.
+ *
+ * @returns {boolean} `true` if the keyboard is visible, `false` otherwise.
+ *
+ * @example
+ * if (isKeyboardVisible()) {
+ *   console.log('Keyboard is open');
+ * } else {
+ *   console.log('Keyboard is closed');
+ * }
+ *
+ * @example
+ * // Conditionally show/hide elements based on keyboard visibility
+ * const showFloatingButton = !isKeyboardVisible();
+ */
+declare function isKeyboardVisible(): boolean;
+//#endregion
+export { isKeyboardVisible };

package/dist/mobile/utils/isKeyboardVisible/isKeyboardVisible.mjs

@@ -0,0 +1,28 @@
+"use client";
+import { getKeyboardHeight } from "../getKeyboardHeight/getKeyboardHeight.mjs";
+//#region src/mobile/utils/isKeyboardVisible/isKeyboardVisible.ts
+/**
+* @description
+* `isKeyboardVisible` is a utility function that checks whether the on-screen keyboard is currently visible.
+*
+* This function uses `getKeyboardHeight()` internally and returns `true`
+* if the keyboard height is greater than 0.
+*
+* @returns {boolean} `true` if the keyboard is visible, `false` otherwise.
+*
+* @example
+* if (isKeyboardVisible()) {
+*   console.log('Keyboard is open');
+* } else {
+*   console.log('Keyboard is closed');
+* }
+*
+* @example
+* // Conditionally show/hide elements based on keyboard visibility
+* const showFloatingButton = !isKeyboardVisible();
+*/
+function isKeyboardVisible() {
+	return getKeyboardHeight() > 0;
+}
+//#endregion
+export { isKeyboardVisible };

package/dist/mobile/utils/isServer/isServer.cjs

@@ -0,0 +1,24 @@
+"use client";
+//#region src/mobile/utils/isServer/isServer.ts
+/**
+* @description
+* `isServer` is a utility function that checks if the code is running on the server.
+* It returns `true` in SSR (Server-Side Rendering) environments where `window` is undefined,
+* and `false` in client-side environments.
+*
+* @returns {boolean} `true` if running in a server environment (SSR), `false` otherwise.
+*
+* @example
+* if (isServer()) {
+*   // SSR-safe code
+*   return null;
+* }
+*
+* // Client-only code
+* window.addEventListener('resize', handleResize);
+*/
+function isServer() {
+	return typeof window === "undefined";
+}
+//#endregion
+exports.isServer = isServer;

package/dist/mobile/utils/isServer/isServer.d.cts

@@ -0,0 +1,22 @@
+
+//#region src/mobile/utils/isServer/isServer.d.ts
+/**
+ * @description
+ * `isServer` is a utility function that checks if the code is running on the server.
+ * It returns `true` in SSR (Server-Side Rendering) environments where `window` is undefined,
+ * and `false` in client-side environments.
+ *
+ * @returns {boolean} `true` if running in a server environment (SSR), `false` otherwise.
+ *
+ * @example
+ * if (isServer()) {
+ *   // SSR-safe code
+ *   return null;
+ * }
+ *
+ * // Client-only code
+ * window.addEventListener('resize', handleResize);
+ */
+declare function isServer(): boolean;
+//#endregion
+export { isServer };

package/dist/mobile/utils/isServer/isServer.d.mts

@@ -0,0 +1,22 @@
+
+//#region src/mobile/utils/isServer/isServer.d.ts
+/**
+ * @description
+ * `isServer` is a utility function that checks if the code is running on the server.
+ * It returns `true` in SSR (Server-Side Rendering) environments where `window` is undefined,
+ * and `false` in client-side environments.
+ *
+ * @returns {boolean} `true` if running in a server environment (SSR), `false` otherwise.
+ *
+ * @example
+ * if (isServer()) {
+ *   // SSR-safe code
+ *   return null;
+ * }
+ *
+ * // Client-only code
+ * window.addEventListener('resize', handleResize);
+ */
+declare function isServer(): boolean;
+//#endregion
+export { isServer };

package/dist/mobile/utils/isServer/isServer.mjs

@@ -0,0 +1,24 @@
+"use client";
+//#region src/mobile/utils/isServer/isServer.ts
+/**
+* @description
+* `isServer` is a utility function that checks if the code is running on the server.
+* It returns `true` in SSR (Server-Side Rendering) environments where `window` is undefined,
+* and `false` in client-side environments.
+*
+* @returns {boolean} `true` if running in a server environment (SSR), `false` otherwise.
+*
+* @example
+* if (isServer()) {
+*   // SSR-safe code
+*   return null;
+* }
+*
+* // Client-only code
+* window.addEventListener('resize', handleResize);
+*/
+function isServer() {
+	return typeof window === "undefined";
+}
+//#endregion
+export { isServer };

package/dist/mobile/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.cjs

@@ -0,0 +1,71 @@
+"use client";
+const require_isServer = require("../isServer/isServer.cjs");
+const require_getKeyboardHeight = require("../getKeyboardHeight/getKeyboardHeight.cjs");
+//#region src/mobile/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.ts
+/**
+* @description
+* `subscribeKeyboardHeight` is a utility function that subscribes to changes in the on-screen keyboard height.
+*
+* The provided callback is invoked whenever the keyboard height may change,
+* including when the keyboard appears, disappears, or changes size.
+*
+* Internally, this function listens to both `resize` and `scroll` events
+* on the Visual Viewport:
+* - `resize`: triggered when the visual viewport height changes
+* - `scroll`: triggered when the visual viewport offset changes
+*   (important for iOS where the viewport can shift without resizing)
+*
+* Performance optimizations:
+* - Throttled by default (16ms, ~60fps) to prevent excessive callback invocations
+* - Skips callback when height hasn't changed (deduplication)
+*
+* @param {SubscribeKeyboardHeightOptions} options - Configuration options
+* @param {(height: number) => void} options.callback - A function that will be called with the updated keyboard height in pixels.
+* @param {boolean} [options.immediate=false] - If true, the callback will be invoked immediately with the current keyboard height.
+* @param {number} [options.throttleMs=16] - Throttle interval in milliseconds.
+*
+* @returns {SubscribeKeyboardHeightResult} An object containing the unsubscribe function.
+* - unsubscribe `() => void` - Unsubscribes all listeners and stops receiving keyboard height updates.
+*
+* @example
+* const { unsubscribe } = subscribeKeyboardHeight({
+*   callback: (height) => {
+*     footer.style.paddingBottom = `${height}px`;
+*   },
+*   immediate: true,
+* });
+*
+* // Later, when cleanup is needed
+* unsubscribe();
+*/
+function subscribeKeyboardHeight({ callback, immediate = false, throttleMs = 16 }) {
+	if (require_isServer.isServer()) return { unsubscribe: () => {} };
+	const visualViewport = window.visualViewport;
+	if (!visualViewport) return { unsubscribe: () => {} };
+	let lastHeight = null;
+	let throttleTimer = null;
+	const handler = () => {
+		if (throttleTimer != null) return;
+		const currentHeight = require_getKeyboardHeight.getKeyboardHeight();
+		if (lastHeight === currentHeight) return;
+		lastHeight = currentHeight;
+		callback(currentHeight);
+		throttleTimer = setTimeout(() => {
+			throttleTimer = null;
+		}, throttleMs);
+	};
+	if (immediate) {
+		const currentHeight = require_getKeyboardHeight.getKeyboardHeight();
+		lastHeight = currentHeight;
+		callback(currentHeight);
+	}
+	visualViewport.addEventListener("resize", handler);
+	visualViewport.addEventListener("scroll", handler);
+	return { unsubscribe: () => {
+		visualViewport.removeEventListener("resize", handler);
+		visualViewport.removeEventListener("scroll", handler);
+		if (throttleTimer != null) clearTimeout(throttleTimer);
+	} };
+}
+//#endregion
+exports.subscribeKeyboardHeight = subscribeKeyboardHeight;

package/dist/mobile/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.d.cts

@@ -0,0 +1,64 @@
+
+//#region src/mobile/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.d.ts
+type SubscribeKeyboardHeightOptions = {
+  /**
+   * A function that will be called with the updated keyboard height in pixels.
+   */
+  callback: (height: number) => void;
+  /**
+   * If true, the callback will be invoked immediately with the current keyboard height.
+   * @default false
+   */
+  immediate?: boolean;
+  /**
+   * Throttle interval in milliseconds.
+   * Events within this interval will be ignored to improve performance.
+   * @default 16 (~60fps)
+   */
+  throttleMs?: number;
+};
+type SubscribeKeyboardHeightResult = {
+  /**
+   * Unsubscribes all listeners and stops receiving keyboard height updates.
+   */
+  unsubscribe: () => void;
+};
+/**
+ * @description
+ * `subscribeKeyboardHeight` is a utility function that subscribes to changes in the on-screen keyboard height.
+ *
+ * The provided callback is invoked whenever the keyboard height may change,
+ * including when the keyboard appears, disappears, or changes size.
+ *
+ * Internally, this function listens to both `resize` and `scroll` events
+ * on the Visual Viewport:
+ * - `resize`: triggered when the visual viewport height changes
+ * - `scroll`: triggered when the visual viewport offset changes
+ *   (important for iOS where the viewport can shift without resizing)
+ *
+ * Performance optimizations:
+ * - Throttled by default (16ms, ~60fps) to prevent excessive callback invocations
+ * - Skips callback when height hasn't changed (deduplication)
+ *
+ * @param {SubscribeKeyboardHeightOptions} options - Configuration options
+ * @param {(height: number) => void} options.callback - A function that will be called with the updated keyboard height in pixels.
+ * @param {boolean} [options.immediate=false] - If true, the callback will be invoked immediately with the current keyboard height.
+ * @param {number} [options.throttleMs=16] - Throttle interval in milliseconds.
+ *
+ * @returns {SubscribeKeyboardHeightResult} An object containing the unsubscribe function.
+ * - unsubscribe `() => void` - Unsubscribes all listeners and stops receiving keyboard height updates.
+ *
+ * @example
+ * const { unsubscribe } = subscribeKeyboardHeight({
+ *   callback: (height) => {
+ *     footer.style.paddingBottom = `${height}px`;
+ *   },
+ *   immediate: true,
+ * });
+ *
+ * // Later, when cleanup is needed
+ * unsubscribe();
+ */
+declare function subscribeKeyboardHeight({ callback, immediate, throttleMs }: SubscribeKeyboardHeightOptions): SubscribeKeyboardHeightResult;
+//#endregion
+export { subscribeKeyboardHeight };