React Native Orientation

Listen to device orientation changes in React Native applications and programmatically set preferred orientation on a per screen basis. Works on both Android and iOS.

Installing

npm install react-native-orientation --save

Linking Native Dependencies

Automatic Linking

react-native link react-native-orientation

Please note that you still need to manually configure a couple files even when using automatic linking. Please see the 'Configuration' section below. You will also need to restart your simulator before the package will work properly.

Manual Linking

iOS

1. Add node_modules/react-native-orientation/iOS/RCTOrientation.xcodeproj to your xcode project, usually under the Libraries group
2. Add libRCTOrientation.a (from Products under RCTOrientation.xcodeproj) to build target's Linked Frameworks and Libraries list
3. Add $(SRCROOT)/node_modules/react-native-orientation/iOS/RCTOrientation/ to Project Name -> Build Settings -> Header Search Paths

Android

1. In android/setting.gradle

   ...
   include ':react-native-orientation', ':app'
   project(':react-native-orientation').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-orientation/android')
   

2. In android/app/build.gradle

   ...
   dependencies {
       ...
       compile project(':react-native-orientation')
   }
   

3. Register module in MainApplication.java

   1import com.github.yamill.orientation.OrientationPackage;  // <--- import
   2
   3public class MainApplication extends Application implements ReactApplication {
   4  ......
   5
   6  @Override
   7  protected List<ReactPackage> getPackages() {
   8      return Arrays.<ReactPackage>asList(
   9          new MainReactPackage(),
   10          new OrientationPackage()      <------- Add this
   11      );
   12  }
   13
   14  ......
   15
   16}

Configuration

iOS

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

1#import "Orientation.h" // <--- import
2
3@implementation AppDelegate
4
5  // ...
6
7- (UIInterfaceOrientationMask)application:(UIApplication *)application supportedInterfaceOrientationsForWindow:(UIWindow *)window {
8  return [Orientation getOrientation];
9}
10  
11
12@end

Android

Implement onConfigurationChanged method in MainActivity.java

1    import android.content.Intent; // <--- import
2    import android.content.res.Configuration; // <--- import
3
4    public class MainActivity extends ReactActivity {
5      ......
6      @Override
7      public void onConfigurationChanged(Configuration newConfig) {
8        super.onConfigurationChanged(newConfig);
9        Intent intent = new Intent("onConfigurationChanged");
10        intent.putExtra("newConfig", newConfig);
11        this.sendBroadcast(intent);
12    }
13
14      ......
15
16    }

Usage

To use the react-native-orientation package in your codebase, you should use the Orientation module:

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

1export default class AppScreen extends Component {
2  // ...
3
4  componentWillMount() {
5    // The getOrientation method is async. It happens sometimes that
6    // you need the orientation at the moment the JS runtime starts running on device.
7    // `getInitialOrientation` returns directly because its a constant set at the
8    // beginning of the JS runtime.
9
10    const initial = Orientation.getInitialOrientation();
11    if (initial === 'PORTRAIT') {
12      // do something
13    } else {
14      // do something else
15    }
16  },
17
18  componentDidMount() {
19    // this locks the view to Portrait Mode
20    Orientation.lockToPortrait();
21
22    // this locks the view to Landscape Mode
23    // Orientation.lockToLandscape();
24
25    // this unlocks any previous locks to all Orientations
26    // Orientation.unlockAllOrientations();
27
28    Orientation.addOrientationListener(this._orientationDidChange);
29  },
30
31  _orientationDidChange = (orientation) => {
32    if (orientation === 'LANDSCAPE') {
33      // do something with landscape layout
34    } else {
35      // do something with portrait layout
36    }
37  },
38
39  componentWillUnmount() {
40    Orientation.getOrientation((err, orientation) => {
41      console.log(`Current Device Orientation: ${orientation}`);
42    });
43
44
45    // Remember to remove listener
46    Orientation.removeOrientationListener(this._orientationDidChange);
47  }
48
49  render() {
50    // ...
51
52    return (
53      // ...
54    )
55  }
56}

Orientation Events

1addOrientationListener((orientation) => {});

orientation will return one of the following values:

• LANDSCAPE
• PORTRAIT
• PORTRAITUPSIDEDOWN
• UNKNOWN

1removeOrientationListener((orientation) => {});

1addSpecificOrientationListener((specificOrientation) => {});

specificOrientation will return one of the following values:

• LANDSCAPE-LEFT
• LANDSCAPE-RIGHT
• PORTRAIT
• PORTRAITUPSIDEDOWN
• UNKNOWN

1removeSpecificOrientationListener((specificOrientation) => {});

API

• lockToPortrait()
• lockToLandscape()
• lockToLandscapeLeft()
• lockToLandscapeRight()
• unlockAllOrientations()
• getOrientation((err, orientation) => {})
• getSpecificOrientation((err, specificOrientation) => {})