Security News
Research
Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
react-native-safe-area-context
Advanced tools
A flexible way to handle safe area, also works on Android and web.
The react-native-safe-area-context package provides a way to handle safe area insets in a React Native application. It helps to ensure that content is not obscured by device notches, status bars, or other screen elements.
SafeAreaProvider
The SafeAreaProvider component is used to wrap the entire application or a part of it to provide safe area insets to its children.
import { SafeAreaProvider } from 'react-native-safe-area-context';
const App = () => {
return (
<SafeAreaProvider>
{/* Your app content */}
</SafeAreaProvider>
);
};
useSafeAreaInsets
The useSafeAreaInsets hook provides the current safe area insets, which can be used to adjust the layout of components to avoid overlaps with device notches or status bars.
import { useSafeAreaInsets } from 'react-native-safe-area-context';
const MyComponent = () => {
const insets = useSafeAreaInsets();
return (
<View style={{ paddingTop: insets.top }}>
{/* Your component content */}
</View>
);
};
SafeAreaView
The SafeAreaView component is a view that automatically applies safe area insets as padding to its children, ensuring that content is not obscured by device notches or status bars.
import { SafeAreaView } from 'react-native-safe-area-context';
const MyScreen = () => {
return (
<SafeAreaView style={{ flex: 1 }}>
{/* Your screen content */}
</SafeAreaView>
);
};
The react-native-safe-area-view package provides a similar functionality to react-native-safe-area-context by offering a SafeAreaView component that applies safe area insets to its children. However, it does not provide hooks like useSafeAreaInsets and is generally considered less flexible.
The react-native-safe-area package offers utilities to handle safe area insets, but it is less comprehensive compared to react-native-safe-area-context. It primarily focuses on providing a SafeAreaView component and lacks the context and hooks provided by react-native-safe-area-context.
A flexible way to handle safe area, also works on Android and Web!
npm install react-native-safe-area-context
yarn add react-native-safe-area-context
You then need to link the native parts of the library for the platforms you are using.
iOS Platform:
$ npx pod-install
version | react-native version |
---|---|
4.0.0+ | 0.64.0+ |
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.
You will need to be on 4.4.0 and react-native 0.70+.
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.
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}
.
initialMetrics
Optional, defaults to null
.
Can be used to provide the initial value for frame and insets, this allows rendering immediatly. See optimization for more information on how to use this prop.
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.
edges
Optional, 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 and 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'}} />
mode
Optional, 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 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) }} />;
}
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 }
SafeAreaInsetsContext
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>
);
}
}
withSafeAreaInsets
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} />;
SafeAreaFrameContext
React Context with the value of the safe area frame.
initialWindowMetrics
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.
Use useSafeAreaInsets
instead.
Use SafeAreaInsetsContext.Consumer
instead.
Use SafeAreaInsetsContext
instead.
Use initialWindowMetrics
instead.
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.
See the Contributing Guide
FAQs
A flexible way to handle safe area, also works on Android and web.
The npm package react-native-safe-area-context receives a total of 974,972 weekly downloads. As such, react-native-safe-area-context popularity was classified as popular.
We found that react-native-safe-area-context demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.