npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-native-window-guard

v1.0.6

Published

SafeAreaView alternative for React Native which provides relevant window insets for both iOS and Android.

Downloads

490

Readme

react-native-window-guard

npm package license

Project represents simple way to handle notches and system ui decorations for React Native. In comparison to alternatives (e.g. SafeAreaView) it works on both iOS and Android and doesn't use hardcoded values, getting all insets with operating system APIs instead.

Android | iOS :-------------------------:|:-------------------------: |

Getting started

$ npm install react-native-window-guard --save

Mostly automatic installation

$ react-native link react-native-window-guard

Manual installation

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-window-guard and add RNWindowGuard.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNWindowGuard.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainApplication.java
  • Add import com.github.greenfrvr.RNWindowGuardPackage; to the imports at the top of the file
  • Add new RNWindowGuardPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-window-guard'
    project(':react-native-window-guard').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-window-guard/android')
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      compile project(':react-native-window-guard')

Usage

Put your layout inside WindowGuard component and define which insets you want to be applied. To make this use applyInsets prop. It takes array with sides which should be affected with insets. Available values: top, bottom, left, right. After this relevant window insets will be requested from native and applied as paddings to WindowGuard component.

For convenience and better perfomance there are serveral insets configurations that are predefined. They are defined statically in WindowGuard. Available predefined insets configurations are:

  • left
  • right
  • top
  • bottom
  • vertical
  • horizontal
  • all

Below is an example of applying insets both for top and bottom sides of your content:

import WindowGuard from 'react-native-window-guard';

export default class App extends React.Component {

  componentDidMount() {
    WindowGuard.requestWindowInsets();
  }

  render() {
    return (
      <WindowGuard
        style={{flex: 1}}
        applyInsets={WindowGuard.vertical}>
        //content
      </WindowGuard>
    );
  }
}

Notice that you can still add paddings to WindowGuard and they will be added to applied window insets. Currently all paddings definitions are supported includeing paddingHorizontal, paddingVertical and padding attributes.

Dynamic changes

Window guard will handle orientation changes and apply new relevant insets automatically for you. Unfortunately there are still cases where you need to handle some ui changes manually. For example hiding status bar. You can request window guard to refresh insets after configuation change by calling adjustInsets method. Below is small usage example:

import WindowGuard from 'react-native-window-guard';

export default class App extends React.Component {

 toggleStatusBar = () => {
   //change statusBarHidden state
   StatusBar.setHidden(statusBarHidden, true);       //change system ui views state
   this.container && this.container.adjustInsets()   //request to refresh insets values
 };

 render() {
   return (
     <WindowGuard
       ref={r => this.container = r}
       style={{flex: 1}}
       applyInsets={WindowGuard.all}>
       //content
     </WindowGuard>
   );
 }
}

HOC

For convenience there is HOC wich will simplify WindowGuard usage. withWindowGuard HOC will return component wrapped into WindowGuard with defined insets configuration. For example

const GuardedView = withWindowGuard(View, WindowGuard.all)

will return View component wrapped into WindowGuard with insets applied to all sides.