import React, { forwardRef, useCallback, useMemo } from "react";
import { View } from "react-native";
import Reanimated, {
interpolate,
runOnUI,
useAnimatedStyle,
useDerivedValue,
useSharedValue,
} from "react-native-reanimated";
import { useWindowDimensions } from "../../hooks";
import { useKeyboardAnimation, useTranslateAnimation } from "./hooks";
import type { LayoutRectangle, ViewProps } from "react-native";
export type KeyboardAvoidingViewBaseProps = {
/**
* Controls whether this `KeyboardAvoidingView` instance should take effect.
* This is useful when more than one is on the screen. Defaults to true.
*/
enabled?: boolean;
/**
* Distance between the top of the user screen and the React Native view. This
* may be non-zero in some cases. Defaults to 0.
*/
keyboardVerticalOffset?: number;
} & ViewProps;
export type KeyboardAvoidingViewProps = KeyboardAvoidingViewBaseProps &
(
| {
/**
* Specify how to react to the presence of the keyboard.
*/
behavior?: "position";
/**
* Style of the content container when `behavior` is 'position'.
*/
contentContainerStyle?: ViewProps["style"];
}
| {
/**
* Specify how to react to the presence of the keyboard.
*/
behavior?: "height" | "padding" | "translate-with-padding";
/**
* `contentContainerStyle` is not allowed for these behaviors.
*/
contentContainerStyle?: never;
}
);
const defaultLayout: LayoutRectangle = {
x: 0,
y: 0,
width: 0,
height: 0,
};
/**
* 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
*
*
*
* ```
*/
const KeyboardAvoidingView = forwardRef<
View,
React.PropsWithChildren
>(
(
{
behavior,
children,
contentContainerStyle,
enabled = true,
keyboardVerticalOffset = 0,
style,
onLayout: onLayoutProps,
...props
},
ref,
) => {
const initialFrame = useSharedValue(null);
const frame = useDerivedValue(() => initialFrame.value || defaultLayout);
const { translate, padding } = useTranslateAnimation();
const keyboard = useKeyboardAnimation();
const { height: screenHeight } = useWindowDimensions();
const relativeKeyboardHeight = useCallback(() => {
"worklet";
const keyboardY =
screenHeight - keyboard.heightWhenOpened.value - keyboardVerticalOffset;
return Math.max(frame.value.y + frame.value.height - keyboardY, 0);
}, [screenHeight, keyboardVerticalOffset]);
const interpolateToRelativeKeyboardHeight = useCallback(
(value: number) => {
"worklet";
return interpolate(value, [0, 1], [0, relativeKeyboardHeight()]);
},
[relativeKeyboardHeight],
);
const onLayoutWorklet = useCallback(
(layout: LayoutRectangle) => {
"worklet";
if (
keyboard.isClosed.value ||
initialFrame.value === null ||
behavior !== "height"
) {
// eslint-disable-next-line react-compiler/react-compiler
initialFrame.value = layout;
}
},
[behavior],
);
const onLayout = useCallback>(
(e) => {
runOnUI(onLayoutWorklet)(e.nativeEvent.layout);
onLayoutProps?.(e);
},
[onLayoutProps],
);
const animatedStyle = useAnimatedStyle(() => {
if (!enabled) {
return {};
}
const bottom = interpolateToRelativeKeyboardHeight(
keyboard.progress.value,
);
const translateY = interpolateToRelativeKeyboardHeight(translate.value);
const paddingBottom = interpolateToRelativeKeyboardHeight(padding.value);
const height = frame.value.height - bottom;
switch (behavior) {
case "height":
if (!keyboard.isClosed.value && height > 0) {
return {
height,
flex: 0,
};
}
return {};
case "position":
return { bottom };
case "padding":
return { paddingBottom: bottom };
case "translate-with-padding":
return {
paddingTop: paddingBottom,
transform: [{ translateY: -translateY }],
};
default:
return {};
}
}, [behavior, enabled, interpolateToRelativeKeyboardHeight]);
const isPositionBehavior = behavior === "position";
const containerStyle = isPositionBehavior ? contentContainerStyle : style;
const combinedStyles = useMemo(
() => [containerStyle, animatedStyle],
[containerStyle, animatedStyle],
);
if (isPositionBehavior) {
return (
{children}
);
}
return (
{children}
);
},
);
export default KeyboardAvoidingView;