콘텐츠로 이동

computeKeyboardRevealOffset — @gj-kit/expo-ui

@gj-kit/expo-ui/insets에서 공개하는 function입니다. package version 0.8.1의 release declaration을 그대로 표시합니다.

import { computeKeyboardRevealOffset } from '@gj-kit/expo-ui/insets';
/**
* Calculates the forward-only scroll offset that keeps a focused input above a
* keyboard and any fixed bottom bar. Returns null when no reveal is needed.
*/
declare function computeKeyboardRevealOffset({ currentOffset, inputHeight, inputTop, keyboardInset, reservedBottomHeight, viewportHeight, margin, }: {
/** The current scroll offset (contentOffset.y). */
currentOffset: number;
/** The height of the focused input. */
inputHeight: number;
/** The top (y) of the focused input inside the scroll content. */
inputTop: number;
/** The keyboard overlap covering the bottom of the viewport. */
keyboardInset: number;
/** The measured height of a fixed bottom bar lifted above the keyboard, or 0 when there is none. */
reservedBottomHeight: number;
/** The scroll viewport height with no keyboard present. */
viewportHeight: number;
/** The gap between the input's bottom edge and the keyboard. Defaults to 16. */
margin?: number | undefined;
}): number | null;

이 선언은 매개변수, optionality, 제네릭, 반환값, 공개 union/type 계약의 정본입니다. 호출 전 필요한 환경·권한·오류 경계는 패키지 Golden path와 이 subpath의 import 조건을 함께 확인하세요.

  • 패키지: @gj-kit/expo-ui
  • 버전: 0.8.1
  • 공개 entry: ./insets
  • 소스: GitHub

Calculates the forward-only scroll offset that keeps a focused input above a keyboard and any fixed bottom bar. Returns null when no reveal is needed.