UNPKG

react-native-safe-area-context

Version:

A flexible way to handle safe area, also works on Android and web.

31 lines (30 loc) 1.2 kB
import * as React from 'react'; import { StyleProp, ViewStyle } from 'react-native'; import { EdgeInsets, Metrics, Rect } from './SafeArea.types'; export declare const SafeAreaInsetsContext: React.Context<EdgeInsets | null>; export declare const SafeAreaFrameContext: React.Context<Rect | null>; export interface SafeAreaViewProps { children?: React.ReactNode; initialMetrics?: Metrics | null; /** * @deprecated */ initialSafeAreaInsets?: EdgeInsets | null; style?: StyleProp<ViewStyle>; } export declare function SafeAreaProvider({ children, initialMetrics, initialSafeAreaInsets, style, }: SafeAreaViewProps): JSX.Element; export declare function useSafeAreaInsets(): EdgeInsets; export declare function useSafeAreaFrame(): Rect; export declare function withSafeAreaInsets<T>(WrappedComponent: React.ComponentType<T>): React.ForwardRefExoticComponent<React.PropsWithoutRef<T> & React.RefAttributes<T>>; /** * @deprecated */ export declare function useSafeArea(): EdgeInsets; /** * @deprecated */ export declare const SafeAreaConsumer: React.Consumer<EdgeInsets | null>; /** * @deprecated */ export declare const SafeAreaContext: React.Context<EdgeInsets | null>;