//#region src/hooks/useKeyboardHeight/useKeyboardHeight.d.ts
type UseKeyboardHeightOptions = {
  /**
   * If true, the hook will get the initial keyboard height on mount.
   * @default true
   */
  immediate?: boolean;
};
type UseKeyboardHeightResult = {
  /**
   * The current keyboard height in pixels.
   */
  keyboardHeight: number;
};
/**
 * @description
 * `useKeyboardHeight` is a React hook that tracks the on-screen keyboard height.
 * It returns the current keyboard height in pixels, which updates automatically
 * when the keyboard appears, disappears, or changes size.
 *
 * @param {UseKeyboardHeightOptions} [options] - Configuration options.
 * @param {boolean} [options.immediate=true] - If true, gets the initial keyboard height on mount.
 *
 * @returns {UseKeyboardHeightResult} An object containing the current keyboard height.
 * - keyboardHeight `number` - The current keyboard height in pixels. 0 when the keyboard is hidden;
 *
 * @example
 * function ChatInput() {
 *   const { keyboardHeight } = useKeyboardHeight();
 *
 *   return (
 *     <div style={{ paddingBottom: `${keyboardHeight}px` }}>
 *       <input type="text" placeholder="Type a message..." />
 *     </div>
 *   );
 * }
 */
declare function useKeyboardHeight(options?: UseKeyboardHeightOptions): UseKeyboardHeightResult;
//#endregion
export { useKeyboardHeight };
//# sourceMappingURL=useKeyboardHeight.d.mts.map