Aucune description
Janic Duplessis 831fd650f7 Fix example app on iOS il y a 4 ans
.github Run CI on PRs, fix lint + ts il y a 5 ans
android Don't use isAttachedToWindow il y a 4 ans
example Fix example app on iOS il y a 4 ans
ios Add support for getting initial safe area insets on mount (#27) il y a 4 ans
src Update dependencies, fix prettier il y a 4 ans
.eslintignore Remove executable bit from non-executable files (#42) il y a 4 ans
.eslintrc.js Remove executable bit from non-executable files (#42) il y a 4 ans
.gitattributes Remove executable bit from non-executable files (#42) il y a 4 ans
.gitignore Remove executable bit from non-executable files (#42) il y a 4 ans
.prettierrc Remove executable bit from non-executable files (#42) il y a 4 ans
.watchmanconfig Initial project setup for ios il y a 5 ans
LICENSE Initial commit il y a 5 ans
README.md Add support for getting initial safe area insets on mount (#27) il y a 4 ans
babel.config.js Remove executable bit from non-executable files (#42) il y a 4 ans
metro.config.js Initial project setup for ios il y a 5 ans
package.json Update dependencies, fix prettier il y a 4 ans
react-native-safe-area-context.podspec Remove executable bit from non-executable files (#42) il y a 4 ans
tsconfig.json Remove executable bit from non-executable files (#42) il y a 4 ans
yarn.lock Update dependencies, fix prettier il y a 4 ans

README.md

react-native-safe-area-context

npm Actions Status 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 { useSafeArea } from 'react-native-safe-area-context';

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

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

Usage with consumer api:

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

class ClassComponent extends React.Component {
  render() {
    return (
      <SafeAreaConsumer>
        {insets => <View style={{ paddingTop: insets.top }} />}
      </SafeAreaConsumer>
    );
  }
}

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 initialSafeAreaInsets to inject insets 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 initialWindowSafeAreaInsets from this package and set as the initialSafeAreaInsets prop on the provider as described in Web SSR. You cannot do this if your provider remounts, or you are using react-native-navigation.

Only supported on iOS at the moment.

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

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

Resources