Janic Duplessis 411672821b 1.0.2 4 anni fa
.github Cache yarn deps 4 anni fa
android Use getWindowVisibleDisplayFrame to calculate edge insets on api < 20 4 anni fa
example Fix flipper package 4 anni fa
ios v2 4 anni fa
src Bring back SafeAreaContext for better compat with 0.x 4 anni fa
.eslintignore Remove executable bit from non-executable files (#42) 4 anni fa
.eslintrc.js Update .eslintrc.js 4 anni fa
.gitattributes Remove executable bit from non-executable files (#42) 4 anni fa
.gitignore v2 4 anni fa
.prettierrc Remove executable bit from non-executable files (#42) 4 anni fa
.watchmanconfig Initial project setup for ios 5 anni fa
LICENSE Initial commit 5 anni fa
README.md Update README.md 4 anni fa
babel.config.js Add react-navigation 4 example 4 anni fa
package.json 1.0.2 4 anni fa
react-native-safe-area-context.podspec Remove executable bit from non-executable files (#42) 4 anni fa
tsconfig.json Make example app easier to run 4 anni fa
yarn.lock Add React Navigation 5 example 4 anni fa

README.md

react-native-safe-area-context

npm CI Supports Android, iOS and web MIT License

A flexible way to handle safe area, also works on Android and Web!

Getting started

Install the library using either Yarn:

yarn add react-native-safe-area-context

or npm:

npm install --save react-native-safe-area-context

You then need to link the native parts of the library for the platforms you are using. The easiest way to link the library is using the CLI tool by running this command from the root of your project:

react-native link react-native-safe-area-context

If you can’t or don’t want to use the CLI tool, you can also manually link the library using the instructions below (click on the arrow to show them):

Manually link the library on iOS

Either follow the instructions in the React Native documentation to manually link the framework or link using Cocoapods by adding this to your Podfile:

pod 'react-native-safe-area-context', :path => '../node_modules/react-native-safe-area-context'

Manually link the library on Android

Make the following changes:

android/settings.gradle

include ':react-native-safe-area-context'
project(':react-native-safe-area-context').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-safe-area-context/android')

android/app/build.gradle

dependencies {
   ...
   implementation project(':react-native-safe-area-context')
}

android/app/src/main/.../MainApplication.java

On top, where imports are:

import com.th3rdwave.safeareacontext.SafeAreaContextPackage;

Add the SafeAreaContextPackage class to your list of exported packages.

@Override
protected List<ReactPackage> getPackages() {
    return Arrays.asList(
            new MainReactPackage(),
            ...
            new SafeAreaContextPackage()
    );
}

Usage

Add SafeAreaProvider in your app root component:

import { SafeAreaProvider } from 'react-native-safe-area-context';

function App() {
  return <SafeAreaProvider>...</SafeAreaProvider>;
}

Usage with hooks api:

import { useSafeAreaInsets } from 'react-native-safe-area-context';

function HookComponent() {
  const insets = useSafeAreaInsets();

  return <View style={{ paddingTop: insets.top }} />;
}

Usage with consumer api:

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>
    );
  }
}

Usage with SafeAreaView:

import { SafeAreaView } from 'react-native-safe-area-context';

function SomeComponent() {
  return (
    <SafeAreaView>
      <View />
    </SafeAreaView>
  );
}

Web SSR

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.

Optimization

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>
  );
}

Resources