@attio/react-native-bottom-sheet-toolbox
Version:
36 lines • 1.89 kB
TypeScript
import type * as React from "react";
import { type StyleProp, type ViewStyle } from "react-native";
import { type SharedValue } from "react-native-reanimated";
import { type UseFooterBottomPositionSharedValueArgs } from "../hooks";
interface BottomSheetOverlayFooterProps extends React.PropsWithChildren, UseFooterBottomPositionSharedValueArgs {
/**
* Forces the internally calculated footer height to some other SharedValue.
*/
footerHeightSharedValue?: SharedValue<number | null>;
/**
* It's very common for footers to have an animated bottom inset, e.g.
* for neatly avoiding the keyboard.
*
* However, as the default footerHeightSharedValue is derived from layout
* calculations this means the consumer is unable to fluctuate the footer's
* height whilst preserving smooth animations.
*
* To get round this the consumer could manage and pass in their own
* footerHeightSharedValue, but this is a hassle. To make life a little
* easier we allow the consumer to instead pass in their own
* bottomInsetSharedValue.
*
* By default, we set this to the keyboard aware safe area bottom inset.
* However, this can be disabled entirely by passing in null.
*/
bottomInsetSharedValue?: SharedValue<number> | null;
/**
* The fallback inset value when using the default bottomInsetSharedValue
* behavior.
*/
keyboardAwareSafeAreaBottomInsetFallback?: number;
style?: StyleProp<Pick<ViewStyle, "backgroundColor">>;
}
export declare function BottomSheetOverlayFooter({ children, footerHeightSharedValue: outerFooterHeightSharedValue, bottomInsetSharedValue: outerBottomInsetSharedValue, style, keyboardAwareSafeAreaBottomInsetFallback, ...hookArgs }: BottomSheetOverlayFooterProps): React.JSX.Element;
export {};
//# sourceMappingURL=bottom-sheet-overlay-footer.d.ts.map