react-native-orientation-locker

A react-native module that can listen on orientation changing of device, get current orientation, lock to preferred orientation. (cross-platform support)

Feature

• lock screen orientation to PORTRAIT|LANDSCAPE-LEFT|PORTRAIT-UPSIDEDOWN|LANDSCAPE-RIGHT.
• listen on orientation changing of device
• get the current orientation of device

ChangeLog

v1.0.21

1. add getDeviceOrientation()
2. orientationDidChange return DeviceOrientation

v1.0.20 abandon

v1.0.19

1. change license to MIT

v1.0.18

1. update build.gradle for RN 0.57
2. format some codes and readme

v1.0.17

1. fix podspec
2. fix "Calling UI code from background thread" error

v1.0.16

1. restore s.dependency 'React' to podspec

v1.0.15

1. remove s.dependency 'React' from podspec

v1.0.14

1. remove "sending orientationDidChange with no listener" warning

v1.0.13

1. fix android lockToLandscapeXXX return error value
2. fix after lockToXXX still can get changed orientation

[more]

Installation

Using npm

npm install react-native-orientation-locker --save
react-native link react-native-orientation-locker

Using CocoaPods (iOS Only)

pod 'react-native-orientation-locker', :path => '../node_modules/react-native-orientation-locker'

Consult the React Native documentation on how to install React Native using CocoaPods.

Configuration

iOS

Add the following to your project's AppDelegate.m:

+#import "Orientation.h"

@implementation AppDelegate

// ...

+- (UIInterfaceOrientationMask)application:(UIApplication *)application supportedInterfaceOrientationsForWindow:(UIWindow *)window {
+  return [Orientation getOrientation];
+}

@end

Android

Implement onConfigurationChanged method (in MainActivity.java)

// ...

+import android.content.Intent;
+import android.content.res.Configuration;

public class MainActivity extends ReactActivity {
    
+   @Override
+   public void onConfigurationChanged(Configuration newConfig) {
+       super.onConfigurationChanged(newConfig);
+       Intent intent = new Intent("onConfigurationChanged");
+       intent.putExtra("newConfig", newConfig);
+       this.sendBroadcast(intent);
+   }

    // ......
}

Usage

Whenever you want to use it within React Native code now you can: import Orientation from 'react-native-orientation-locker';

import Orientation from 'react-native-orientation-locker';


  _onOrientationDidChange = (orientation) => {
    if (orientation == 'LANDSCAPE-LEFT') {
      //do something with landscape left layout
    } else {
      //do something with portrait layout
    }
  };

  componentWillMount() {
    //The getOrientation method is async. It happens sometimes that
    //you need the orientation at the moment the js starts running on device.
    //getInitialOrientation returns directly because its a constant set at the
    //beginning of the js code.
    var initial = Orientation.getInitialOrientation();
    if (initial === 'PORTRAIT') {
      //do stuff
    } else {
      //do other stuff
    }
  },

  componentDidMount() {

    Orientation.lockToPortrait(); //this will lock the view to Portrait
    //Orientation.lockToLandscapeLeft(); //this will lock the view to Landscape
    //Orientation.unlockAllOrientations(); //this will unlock the view to all Orientations

    //get current orientation
    /*
    Orientation.getOrientation((orientation,deviceOrientation)=> {
      console.log("Current UI Orientation: ", orientation);
      console.log("Current Device Orientation: ", deviceOrientation);
    });
    */

    Orientation.addOrientationListener(this._onOrientationDidChange);
  },

  componentWillUnmount: function() {
    Orientation.removeOrientationListener(this._onOrientationDidChange);
  }

Events

• addOrientationListener(function(orientation,deviceOrientation))

orientation can return either PORTRAIT LANDSCAPE-LEFT LANDSCAPE-RIGHT PORTRAIT-UPSIDEDOWN UNKNOWN

• removeOrientationListener(function(orientation,deviceOrientation))

Functions

• lockToPortrait()
• lockToLandscape()
• lockToLandscapeLeft() this will lock to camera left home button right
• lockToLandscapeRight() this will lock to camera right home button left
• unlockAllOrientations()
• getOrientation(function(orientation))
• getDeviceOrientation(function(orientation))

orientation can return one of:

• PORTRAIT
• LANDSCAPE-LEFT camera left home button right
• LANDSCAPE-RIGHT camera right home button left
• PORTRAIT-UPSIDEDOWN
• UNKNOWN

Notice: PORTRAIT-UPSIDEDOWN not support at iOS now