mirror of
https://github.com/apache/cordova-plugin-screen-orientation.git
synced 2025-02-24 09:02:51 +08:00
130 lines
4.1 KiB
Markdown
130 lines
4.1 KiB
Markdown
# 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](http://www.w3.org/TR/screen-orientation/) so the api does not currently match the current spec.
|
|
|
|
The plugin adds the following to the screen object:
|
|
|
|
__lockOrientation(ORIENTATION_STRING)__
|
|
lock the device orientation
|
|
|
|
__unlockOrientation()__
|
|
unlock the orientation
|
|
|
|
__orientation__
|
|
current orientation (ORIENTATION_STRING)
|
|
|
|
## 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!).
|
|
|
|
## Android Notes
|
|
|
|
The __screen.orientation__ property will not update when the phone is [rotated 180 degrees](http://www.quirksmode.org/dom/events/orientationchange.html).
|
|
|
|
## 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.__
|
|
|
|
#### iOS6
|
|
|
|
There has been a few cases where the rotation does not change the width of the viewport
|
|
|
|
Issue [#1](https://github.com/gbenvenuti/cordova-plugin-screen-orientation/issues/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.3.7
|
|
* Added Windows 8.1 Support
|
|
|
|
## 1.3.5-6
|
|
* Plugin added to npm
|
|
|
|
## 1.3.4
|
|
* Readme update
|
|
|
|
## 1.3.3
|
|
* [#53](https://github.com/gbenvenuti/cordova-plugin-screen-orientation/pull/53) WP8 Support
|
|
|
|
## 1.3.2
|
|
|
|
* [#33](https://github.com/gbenvenuti/cordova-plugin-screen-orientation/issues/33) iOS8 Delay Block
|
|
|
|
## 1.3.0
|
|
|
|
* [#23](https://github.com/gbenvenuti/cordova-plugin-screen-orientation/issues/23) iOS8 flicker
|
|
|
|
## 1.2.0-1.2.1
|
|
|
|
* [#19](https://github.com/gbenvenuti/cordova-plugin-screen-orientation/issues/19) iOS8 Crash
|
|
|
|
|
|
|
|
Pull requests welcome.
|