node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »

cordova-plugin-screen-orientation

Android 4.4 Android 5.1 Android 6.0 iOS 9.3 iOS 10.0 Windows 10 Store
Build Status Build Status Build Status Build Status Build Status Build Status

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 Screen Orientation API so the api matches the current spec.

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

// lock the device orientation 
.orientation.lock('portrait')
 
// unlock the orientation 
.orientation.unlock()
 
// current orientation 
.orientation

Install

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 unlocked - all orientations are supported.

Usage

// set to either landscape 
screen.orientation.lock('landscape');
 
// allow user rotate 
screen.orientation.unlock();
 
// access current orientation 
console.log('Orientation is ' + screen.orientation.type);

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.

Example usage

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

The 'change' event listener has also been added to the screen.orientation object.

Example usage

screen.orientation.addEventListener('change', function(){
    console.log(screen.orientation.type); // e.g. portrait 
});
    // OR 
 
screen.orientation.onchange = function(){console.log(screen.orientation.type);
};
 

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.

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.

Legacy Changelog

See RELEASENOTES.md for the automated changelog.

Changelog

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