useModalKeyboardOverlap — @gj-kit/expo-ui

A public function from @gj-kit/expo-ui/insets. The signature below is taken directly from the 0.8.1 release declaration.

Verified import example

import { useModalKeyboardOverlap } from '@gj-kit/expo-ui/insets';

Signature, parameters, and return type

/**
 * How much of a bottom-anchored sheet inside a separate native window (`<Modal>`)
 * the keyboard covers. Apply it directly as the sheet container's paddingBottom.
 *
 * KeyboardAvoidingView cannot be used here. An Android edge-to-edge Modal window
 * (with statusBarTranslucent) does not resize when the keyboard opens, and KAV's
 * frame math is off inside that window as well, so neither the "height" nor the
 * "padding" behavior lifts the sheet (reproduced and confirmed in the memorylog2
 * album record upload sheet). Hence the direct subscription to keyboard events.
 *
 * Android keyboard events report the IME height measured above the system
 * navigation inset, but an edge-to-edge Modal window extends below the navigation
 * bar, so insets.bottom has to be added to get the real occlusion. iOS reports the
 * full occlusion as is.
 */
declare function useModalKeyboardOverlap(): number;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/expo-ui
• Version: 0.8.1
• Public entry: ./insets
• Source: GitHub