github/cordova-plugin-screen-orientation
github/cordova-plugin-screen-orientation
3
0
Fork 0
mirror of https://github.com/apache/cordova-plugin-screen-orientation.git synced 2025-02-23 16:42:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #78 from mrzmyr/patch-1

Browse Source 
Add more readability
This commit is contained in:
Grant Benvenuti 2016-02-05 09:46:33 +10:00
commit d89dc2ab41
1 changed files with 40 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -2,73 +2,81 @@
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:
The plugin adds the following to the screen object (`window.screen`):
__lockOrientation(ORIENTATION_STRING)__
lock the device orientation
```js
// lock the device orientation
.lockOrientation('portrait')
__unlockOrientation()__
unlock the orientation
// unlock the orientation
.unlockOrientation()
__orientation__
current orientation (ORIENTATION_STRING)
// current orientation
.orientation
```
## Install
cordova < 4
_cordova < 4_
```bash
cordova plugin add net.yoik.cordova.plugins.screenorientation
```
_cordova > 4_
cordova > 4
```bash
cordova plugin add cordova-plugin-screen-orientation
```
## Supported Orientations
__portrait-primary__
The orientation is in the primary portrait mode.
#### portrait-primary
> The orientation is in the primary portrait mode.
__portrait-secondary__
The orientation is in the secondary portrait mode.
#### portrait-secondary
> The orientation is in the secondary portrait mode.
__landscape-primary__
The orientation is in the primary landscape mode.
#### landscape-primary
> The orientation is in the primary landscape mode.
__landscape-secondary__
The orientation is in the secondary landscape mode.
#### landscape-secondary
> The orientation is in the secondary landscape mode.
__portrait__
The orientation is either portrait-primary or portrait-secondary (sensor).
#### portrait
> The orientation is either portrait-primary or portrait-secondary (sensor).
__landscape__
The orientation is either landscape-primary or landscape-secondary (sensor).
#### landscape
> The orientation is either landscape-primary or landscape-secondary (sensor).
## Usage
// set to either landscape
screen.lockOrientation('landscape');
```js
// set to either landscape
screen.lockOrientation('landscape');
// allow user rotate
screen.unlockOrientation();
// allow user rotate
screen.unlockOrientation();
// access current orientation
console.log('Orientation is ' + screen.orientation);
// 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('Orientation changed to ' + screen.orientation);
});
```js
window.addEventListener("orientationchange", function(){
console.log(screen.orientation); // e.g. portrait
});
```
## Android Notes