@rescript-react-native/safe-area-context

ReScript bindings for react-native-safe-area-context.

Exposed as ReactNativeSafeAreaContext module.

@rescript-react-native/safe-area-context X.y.* means it's compatible with react-native-safe-area-context X.y.*

Installation

When react-native-safe-area-context is properly installed & configured by following their installation instructions, you can install the bindings:

1npm install @rescript-react-native/safe-area-context
2# or
3yarn add @rescript-react-native/safe-area-context

@rescript-react-native/safe-area-context should be added to bs-dependencies in your rescript.json:

1{
2  //...
3  "bs-dependencies": [
4    "@rescript/react",
5    "rescript-react-native",
6    // ...
7+    "@rescript-react-native/safe-area-context"
8  ],
9  //...
10}

Usage

Types

ReactNativeSafeAreaContext.insets

1type insets = {
2  top: float,
3  bottom: float,
4  left: float,
5  right: float,
6};

ReactNativeSafeAreaContext.frame

1type frame = {
2  x: float,
3  y: float,
4  width: float,
5  height: float,
6};

ReactNativeSafeAreaContext.metrics

1type metrics = {
2  insets,
3  frame,
4};

Constants

initialWindowMetrics

See https://github.com/th3rdwave/react-native-safe-area-context#optimization

Methods

<ReactNativeSafeAreaContext.SafeAreaProvider>

1open ReactNative;
2open ReactNativeSafeAreaContext;
3
4@react.component
5let make = () => {
6  <SafeAreaProvider /*initialMetrics={...}*/>
7    // your app...
8    <View />
9  <SafeAreaProvider>;
10}

See https://github.com/th3rdwave/react-native-safe-area-context#web-ssr for initialMetrics.

ReactNativeSafeAreaContext.useSafeAreaInsets(): insets

1open ReactNative;
2open ReactNativeSafeAreaContext;
3
4@react.component
5let make = () => {
6  let insets = useSafeAreaInsets();
7  <View style=Style.(style(~paddingTop=insets.top, ())) />;
8}

ReactNativeSafeAreaContext.useSafeAreaFrame(): frame

1open ReactNative;
2open ReactNativeSafeAreaContext;
3
4@react.component
5let make = () => {
6  let frame = useSafeAreaFrame();
7  <View style=Style.(style(~height=frame.height, ())) />;
8}

<ReactNativeSafeAreaContext.SafeAreaInsetsContext.Consumer>

1open ReactNative;
2open ReactNativeSafeAreaContext;
3
4@react.component
5let make = () => {
6  <SafeAreaInsetsContext.Consumer>
7    // your component, handy for classes
8    {insets => <View style=Style.(style(~paddingTop=insets##top, ())) />}
9  <SafeAreaInsetsContext.Consumer>;
10}

<ReactNativeSafeAreaContext.SafeAreaView>

1open ReactNative;
2open ReactNativeSafeAreaContext;
3
4@react.component
5let make = () => {
6  <SafeAreaView>
7    <View />
8  <SafeAreaView>;
9}

---

Changelog

Check the changelog for more informations about recent releases.

---

Contribute

Read the contribution guidelines before contributing.

Code of Conduct

We want this community to be friendly and respectful to each other. Please read our full code of conduct so that you can understand what actions will and will not be tolerated.