Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/cordova-plugin-screen-orientation
Apache Cordova Screen Orientation Plugin
https://github.com/apache/cordova-plugin-screen-orientation
android cordova hacktoberfest ios java javascript library mobile nodejs objective-c
Last synced: 3 days ago
JSON representation
Apache Cordova Screen Orientation Plugin
- Host: GitHub
- URL: https://github.com/apache/cordova-plugin-screen-orientation
- Owner: apache
- License: apache-2.0
- Created: 2016-06-02T07:00:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T01:32:31.000Z (3 months ago)
- Last Synced: 2025-01-02T12:07:28.322Z (10 days ago)
- Topics: android, cordova, hacktoberfest, ios, java, javascript, library, mobile, nodejs, objective-c
- Language: JavaScript
- Homepage: https://cordova.apache.org/
- Size: 264 KB
- Stars: 219
- Watchers: 32
- Forks: 229
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
---
title: Screen Orientation
description: Set the screen orientation
---
# Cordova Screen Orientation Plugin
[](https://github.com/apache/cordova-plugin-screen-orientation/actions/workflows/android.yml) [](https://github.com/apache/cordova-plugin-screen-orientation/actions/workflows/chrome.yml) [](https://github.com/apache/cordova-plugin-screen-orientation/actions/workflows/ios.yml) [](https://github.com/apache/cordova-plugin-screen-orientation/actions/workflows/lint.yml)
Cordova plugin to set/lock the screen orientation in a common way for iOS, Android, and windows-uwp. This plugin is based on [Screen Orientation API](http://www.w3.org/TR/screen-orientation/) so the api matches the current spec.
The plugin adds the following to the screen object (`window.screen`):
```js
// lock the device orientation
.orientation.lock('portrait')
// unlock the orientation
.orientation.unlock()
// current orientation
.orientation
```
## Install
```bash
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
```js
// 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
```js
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
```js
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](http://www.quirksmode.org/dom/events/orientationchange.html).
## Windows UWP Notes
Windows store apps (windows-uwp) 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.