import * as React from 'react'; import { Dimensions, StyleProp, StyleSheet, ViewStyle } from 'react-native'; import NativeSafeAreaProvider from './NativeSafeAreaProvider'; import { EdgeInsets, InsetChangedEvent, Metrics, Rect } from './SafeArea.types'; export const SafeAreaInsetsContext = React.createContext( null, ); SafeAreaInsetsContext.displayName = 'SafeAreaInsetsContext'; export const SafeAreaFrameContext = React.createContext(null); SafeAreaFrameContext.displayName = 'SafeAreaFrameContext'; export interface SafeAreaViewProps { children?: React.ReactNode; initialMetrics?: Metrics | null; /** * @deprecated */ initialSafeAreaInsets?: EdgeInsets | null; style?: StyleProp; } export function SafeAreaProvider({ children, initialMetrics, initialSafeAreaInsets, style, }: SafeAreaViewProps) { const parentInsets = useParentSafeAreaInsets(); const parentFrame = useParentSafeAreaFrame(); const [insets, setInsets] = React.useState( initialMetrics?.insets ?? initialSafeAreaInsets ?? parentInsets ?? null, ); const [frame, setFrame] = React.useState( initialMetrics?.frame ?? parentFrame ?? { // Backwards compat so we render anyway if we don't have frame. x: 0, y: 0, width: Dimensions.get('window').width, height: Dimensions.get('window').height, }, ); const onInsetsChange = React.useCallback( (event: InsetChangedEvent) => { const { nativeEvent: { frame: nextFrame, insets: nextInsets }, } = event; if ( // Backwards compat with old native code that won't send frame. nextFrame && (nextFrame.height !== frame.height || nextFrame.width !== frame.width || nextFrame.x !== frame.x || nextFrame.y !== frame.y) ) { setFrame(nextFrame); } if ( !insets || nextInsets.bottom !== insets.bottom || nextInsets.left !== insets.left || nextInsets.right !== insets.right || nextInsets.top !== insets.top ) { setInsets(nextInsets); } }, [frame, insets], ); return ( {insets != null ? ( {children} ) : null} ); } const styles = StyleSheet.create({ fill: { flex: 1 }, }); function useParentSafeAreaInsets(): EdgeInsets | null { return React.useContext(SafeAreaInsetsContext); } function useParentSafeAreaFrame(): Rect | null { return React.useContext(SafeAreaFrameContext); } export function useSafeAreaInsets(): EdgeInsets { const safeArea = React.useContext(SafeAreaInsetsContext); if (safeArea == null) { throw new Error( 'No safe area insets value available. Make sure you are rendering `` at the top of your app.', ); } return safeArea; } export function useSafeAreaFrame(): Rect { const frame = React.useContext(SafeAreaFrameContext); if (frame == null) { throw new Error( 'No safe area frame value available. Make sure you are rendering `` at the top of your app.', ); } return frame; } export function withSafeAreaInsets( WrappedComponent: React.ComponentType, ) { return React.forwardRef((props: T, ref: React.Ref) => ( {(insets) => } )); } /** * @deprecated */ export function useSafeArea(): EdgeInsets { return useSafeAreaInsets(); } /** * @deprecated */ export const SafeAreaConsumer = SafeAreaInsetsContext.Consumer; /** * @deprecated */ export const SafeAreaContext = SafeAreaInsetsContext;