Janic Duplessis d12858ccde Update example 5 年前
android Rename android package, add readme instructions 5 年前
example Rename android package, add readme instructions 5 年前
ios Change api, fix android 5 年前
src Add consumer api 5 年前
.eslintignore Initial project setup for ios 5 年前
.eslintrc.js Change api, fix android 5 年前
.gitattributes Initial project setup for ios 5 年前
.gitignore Initial project setup for ios 5 年前
.prettierrc Initial project setup for ios 5 年前
.watchmanconfig Initial project setup for ios 5 年前
LICENSE Initial commit 5 年前
README.md Update example 5 年前
babel.config.js Rename to react-native-safe-area-context 5 年前
metro.config.js Initial project setup for ios 5 年前
package.json Rename android package, add readme instructions 5 年前
react-native-safe-area-context.podspec Rename to react-native-safe-area-context 5 年前
tsconfig.json Initial project setup for ios 5 年前
yarn.lock Update yarn.lock 5 年前

README.md

react-native-safe-area-context

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

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