Use useSafeAreaInsets instead.
-Use SafeAreaInsetsContext.Consumer instead.
-Use SafeAreaInsetsContext instead.
-Use initialWindowMetrics instead.
Insets and frame of the window on initial render. This can be used with the initialMetrics from SafeAreaProvider. See optimization for more information.
Object with:
-{
frame: { x: number, y: number, width: number, height: number },
insets: { top: number, left: number, right: number, bottom: number },
}
NOTE: This value can be null or out of date as it is computed when the native module is created.
React Context with the value of the safe area frame.
React Context with the value of the safe area insets.
-Can be used with class components:
-import { SafeAreaInsetsContext } from 'react-native-safe-area-context';
class ClassComponent extends React.Component {
render() {
return (
<SafeAreaInsetsContext.Consumer>
{(insets) => <View style={{ paddingTop: insets.top }} />}
</SafeAreaInsetsContext.Consumer>
);
}
}
Component that lets you listen to safe area insets and frame changes at the position where it is rendered.
-This is an alternative to using the useSafeAreaInsets and useSafeAreaFrame hooks in combinations with SafeAreaProvider. Unlike the hooks, this notifies about changes with the onChange prop and doesn't trigger re-renders when the insets or frame change.
import { SafeAreaListener } from 'react-native-safe-area-context';
function SomeComponent() {
return (
<SafeAreaListener
onChange={({ insets, frame }) => {
console.log('Safe area changed:', { insets, frame });
}}
>
{/* Your content here */}
</SafeAreaListener>
);
}
Accepts all View props.
-onChangeRequired, a function that receives an object with insets and frame properties. The insets property contains the safe area insets, and the frame property contains the frame of the component.
You should add SafeAreaProvider in your app root component. You may need to add it in other places like the root of modals and routes when using react-native-screens.
Note that providers should not be inside a View that is animated with Animated or inside a ScrollView since it can cause very frequent updates.
import { SafeAreaProvider } from 'react-native-safe-area-context';
function App() {
return <SafeAreaProvider>{/*...*/}</SafeAreaProvider>;
}
Accepts all View props. Has a default style of {flex: 1}.
initialMetricsOptional, defaults to null.
Can be used to provide the initial value for frame and insets, this allows rendering immediately. See optimization for more information on how to use this prop.
-refOptional ref to the underlying view.
SafeAreaView is a regular View component with the safe area insets applied as padding or margin.
Padding or margin styles are added to the insets, for example style={{paddingTop: 10}} on a SafeAreaView that has insets of 20 will result in a top padding of 30.
import { SafeAreaView } from 'react-native-safe-area-context';
function SomeComponent() {
return (
<SafeAreaView style={{ flex: 1, backgroundColor: 'red' }}>
<View style={{ flex: 1, backgroundColor: 'blue' }} />
</SafeAreaView>
);
}
Accepts all View props.
-edgesOptional, array of top, right, bottom, and left. Defaults to all.
Sets the edges to apply the safe area insets to.
-For example if you don't want insets to apply to the top edge because the view does not touch the top of the screen you can use:
-<SafeAreaView edges={['right', 'bottom', 'left']} />
Optionally it can be set to an object { top?: EdgeMode, right?: EdgeMode, bottom?: EdgeMode, left?: EdgeMode } where EdgeMode = 'off' | 'additive' | 'maximum'. Additive is a default mode and is the same as passing an edge in the array: finalPadding = safeArea + padding. Maximum mode will use safe area inset or padding/margin (depends on mode) if safe area is less: finalPadding = max(safeArea, padding). For example if you want a floating UI element that should be at the bottom safe area edge on devices with safe area or 24px from the bottom of the screen on devices without safe area or if safe area is less than 24px:
<SafeAreaView style={{paddingBottom: 24}} edges={{bottom: 'maximum'}} />
modeOptional, padding (default) or margin.
Apply the safe area to either the padding or the margin.
-This can be useful for example to create a safe area aware separator component:
-<SafeAreaView mode="margin" style={{ height: 1, backgroundColor: '#eee' }} />
Returns the frame of the nearest provider. This can be used as an alternative to the Dimensions module.
Object with { x: number, y: number, width: number, height: number }
Returns the safe area insets of the nearest provider. This allows manipulating the inset values from JavaScript. Note that insets are not updated synchronously so it might cause a slight delay for example when rotating the screen.
-Object with { top: number, right: number, bottom: number, left: number }.
import { useSafeAreaInsets } from 'react-native-safe-area-context';
function HookComponent() {
const insets = useSafeAreaInsets();
return <View style={{ paddingBottom: Math.max(insets.bottom, 16) }} />;
}
Higher order component that provides safe area insets as the insets prop.
type Props = WithSafeAreaInsetsProps & {
someProp: number;
};
class ClassComponent extends React.Component<Props> {
render() {
return <View style={{ paddingTop: this.props.insets.top }} />;
}
}
const ClassComponentWithInsets = withSafeAreaInsets(ClassComponent);
<ClassComponentWithInsets someProp={1} />;
You should add SafeAreaProvider in your app root component. You may need to add it in other places like the root of modals and routes when using react-native-screens.
Component that lets you listen to safe area insets and frame changes at the position where it is rendered.
SafeAreaView is a regular View component with the safe area insets applied as padding or margin.
Returns the safe area insets of the nearest provider. This allows manipulating the inset values from JavaScript. Note that insets are not updated synchronously so it might cause a slight delay for example when rotating the screen.
Returns the frame of the nearest provider. This can be used as an alternative to the Dimensions module.
React Context with the value of the safe area insets.
React Context with the value of the safe area frame.
Higher order component that provides safe area insets as the insets prop.
Insets and frame of the window on initial render. This can be used with the initialMetrics from SafeAreaProvider. See optimization for more information.
useSafeArea
Use yarn to install development dependencies.
-yarn install
If you don't have bundler installed:
-gem install bundler
Move to the example directory and install dependencies there too.
cd example
yarn install
bundle install
cd ios && bundle exec pod install
Start the example app to test your changes. You can use one of the following commands from the repo root, depending on the platform you want to use.
-From the example directory:
yarn ios
I also recommend opening example/ios/SafeAreaViewExample.xcworkspace in Xcode if you need to make changes to native code.
yarn android
I also recommend opening example/android in Android Studio if you need to make changes to native code.
Use ctrl+cmd+z on iOS or ctrl+m on Android to open the dev menu and choose an example.
yarn test
npm install react-native-safe-area-context
yarn add react-native-safe-area-context
| react-native-safe-area-context version | react-native version |
|---|---|
| 5.x | >= 0.75 |
| 4.x | 0.64 - 0.74 |
This library currently has experimental support for the new react-native architecture. Note that there will be breaking changes and only the latest version of react-native will be supported.
-See the Contributing Guide
If you are doing server side rendering on the web you can use initialMetrics to inject insets and frame value based on the device the user has, or simply pass zero values. Since insets measurement is async it will break rendering your page content otherwise.
If you can, use SafeAreaView. It's implemented natively so when rotating the device, there is no delay from the asynchronous bridge.
To speed up the initial render, you can import initialWindowMetrics from this package and set as the initialMetrics prop on the provider as described in Web SSR. You cannot do this if your provider remounts, or you are using react-native-navigation.
import {
SafeAreaProvider,
initialWindowMetrics,
} from 'react-native-safe-area-context';
function App() {
return (
<SafeAreaProvider initialMetrics={initialWindowMetrics}>
...
</SafeAreaProvider>
);
}
This library includes a built in mock for Jest. It will use the following metrics by default:
-{
frame: {
width: 320,
height: 640,
x: 0,
y: 0,
},
insets: {
left: 0,
right: 0,
bottom: 0,
top: 0,
},
}
To use it, add the following code to the jest setup file:
-import mockSafeAreaContext from 'react-native-safe-area-context/jest/mock';
jest.mock('react-native-safe-area-context', () => mockSafeAreaContext);
To have more control over the test values it is also possible to pass initialMetrics to
-SafeAreaProvider to provide mock data for frame and insets.
export function TestSafeAreaProvider({ children }) {
return (
<SafeAreaProvider
initialMetrics={{
frame: { x: 0, y: 0, width: 0, height: 0 },
insets: { top: 0, left: 0, right: 0, bottom: 0 },
}}
>
{children}
</SafeAreaProvider>
);
}
While trying to use this mock, a frequently encountered error is:
-SyntaxError: Cannot use import statement outside a module.
This issue arises due to the use of the import statement. To resolve it, you need to permit Babel to parse the file.
-By default, Jest does not parse files located within the node_modules folder.
-However, you can modify this behavior as outlined in the Jest documentation on transformIgnorePatterns customization.
-If you're using a preset, like the one from react-native, you should update your Jest configuration to include react-native-safe-area-context as shown below:
transformIgnorePatterns: [
'node_modules/(?!((jest-)?react-native|@react-native(-community)?|react-native-safe-area-context)/)',
];
This adjustment ensures Babel correctly parses modules, avoiding the aforementioned syntax error.
This library has 2 important concepts, if you are familiar with React Context this is very similar.
-The SafeAreaProvider component is a View from where insets provided by consumers are relative to. This means that if this view overlaps with any system elements (status bar, notches, etc.) these values will be provided to descendent consumers. Usually you will have one provider at the top of your app.
Consumers are components and hooks that allow using inset values provided by the nearest parent provider. Values are always relative to a provider and not to these components.
-SafeAreaView is the preferred way to consume insets. This is a regular View with insets applied as extra padding or margin. It offers better performance by applying insets natively and avoids flickers that can happen with the other JS based consumers.
useSafeAreaInsets offers more flexibility, but can cause some layout flicker in certain cases. Use this if you need more control over how insets are applied.
-The safe area insets do not include the software keyboard. It is recommended to use react-native-keyboard-controller to handle those.
npm install react-native-safe-area-context
Build layouts your wayUse safe area insets directly from JavaScript instead of calculating offsets for different devices. Set the padding or margins you want and let the safe area handle the rest.
Same API across platformsHandle safe areas on iOS, Android, and web without writing separate logic for each platform.
Better handling during rotationSafeAreaView applies safe area insets natively, so your layout can update when the device rotates without waiting for a JavaScript update.
