No Description
Janic Duplessis c94dc4fcd9 Add bob 5 years ago
.github Run CI on PRs, fix lint + ts 5 years ago
android Rename android package, add readme instructions 5 years ago
example Added web support 5 years ago
ios Update RNCSafeAreaViewManager.m 5 years ago
src Use export type instead of export {} to fix isolatedModules 5 years ago
.eslintignore Initial project setup for ios 5 years ago
.eslintrc.js Change api, fix android 5 years ago
.gitattributes Initial project setup for ios 5 years ago
.gitignore Initial project setup for ios 5 years ago
.prettierrc Initial project setup for ios 5 years ago
.watchmanconfig Initial project setup for ios 5 years ago
LICENSE Initial commit 5 years ago
README.md Update README.md 5 years ago
babel.config.js Rename to react-native-safe-area-context 5 years ago
metro.config.js Initial project setup for ios 5 years ago
package.json Add bob 5 years ago
react-native-safe-area-context.podspec Rename to react-native-safe-area-context 5 years ago
tsconfig.json Run CI on PRs, fix lint + ts 5 years ago
yarn.lock Add bob 5 years ago

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!

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