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).

any

orientation is 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.

BB10 Notes

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

Changelog

2.0

• Common javascript for iOS, Android and Windows.

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.