Cordova Screen Orientation Plugin

Cordova plugin to set/lock the screen orientation in a common way for iOS, Android, WP8 and Blackberry 10. This plugin is based on an early version of Screen Orientation API so the api does not currently match the current spec.

The plugin adds the following to the screen object (window.screen):

// lock the device orientation
.lockOrientation('portrait')

// unlock the orientation
.unlockOrientation()

// current orientation
.orientation

Install

cordova < 4

cordova plugin add net.yoik.cordova.plugins.screenorientation

cordova > 4

cordova plugin add cordova-plugin-screen-orientation

Supported Orientations

portrait-primary

The orientation is in the primary portrait mode.

portrait-secondary

The orientation is in the secondary portrait mode.

landscape-primary

The orientation is in the primary landscape mode.

landscape-secondary

The orientation is in the secondary landscape mode.

portrait

The orientation is either portrait-primary or portrait-secondary (sensor).

landscape

The orientation is either landscape-primary or landscape-secondary (sensor).

Usage

// set to either landscape
screen.lockOrientation('landscape');

// allow user rotate
screen.unlockOrientation();

// access current orientation
console.log('Orientation is ' + screen.orientation);

Events

Both android and iOS will fire the orientationchange event on the window object. For this version of the plugin use the window object if you require notification.

For this plugin to follow the full API events should be fired on the screen object. iOS and BB10 do not currently support events on the screen object so custom event handling will need to be added (Suggestions welcome!).

Example usage

window.addEventListener("orientationchange", function(){
    console.log(screen.orientation); // e.g. portrait
});

Android Notes

The screen.orientation property will not update when the phone is rotated 180 degrees.

iOS Notes

The iOS version is a combination of the cordova JS callback window.shouldRotateToOrientation and the workaround to recheck the orientation as implemented in https://github.com/Adlotto/cordova-plugin-recheck-screen-orientation.

If you have a custom implementation of the window.shouldRotateToOrientation it will have to be removed for the plugin to function as expected.

An optional parameter can be passed to screen.unlockOrientation:

// default behaviour
screen.unlockOrientation() 

// force to unlock all possible orientation modes
screen.unlockOrientation(true) 

iOS6

There has been a few cases where the rotation does not change the width of the viewport

Issue #1 @dokterbob

It seems to be related to having width=device-width, height=device-height in the meta viewport (which is part of the boilerplate phonegap/cordova app). It can be solved by updating the viewport with width=device-height, height=device-width or simply removing width and height altogether.

iOS8

Versions prior to 1.2.0 will cause an application crash in iOS8 due to a change in presentViewController timing.

BB10 Notes

Wraps the com.blackberry.app plugin functions, auto installed as a dependancy.

WP8 Notes

Windows phone does not support specification or primary and secondary orientations. If called with a specific orientation the plugin will just apply the landscape or portait orientation.

W8.1 Notes

Windows 8.1 Applicaitons (runtime/metro applications) will only display orientation changes if the device has some sort of accelerometer. The internal state of the "orientation" will still be kept, but the actual screen won't rotate unless the device supports it.

Changelog

1.4.2

• #101 make iOS rotate as needed when lockOrientation is called

1.4.1

• #89 Fix for cordova >= 3.6.3

1.4.0

• Added Windows 8.1 Support
• #54 Background thread for ios
• #64 Orientation naming bug fixed
• Add portrait upside down to iOS default orientations

1.3.5-6

• Plugin added to npm

1.3.4

• Readme update

1.3.3

• #53 WP8 Support

1.3.2

• #33 iOS8 Delay Block

1.3.0

• #23 iOS8 flicker

1.2.0-1.2.1

• #19 iOS8 Crash

Pull requests welcome.