Screen Orientation

Improve this doc

Cordova plugin to set/lock the screen orientation in a common way.

Requires Cordova plugin: cordova-plugin-screen-orientation. For more info, please see the Screen Orientation plugin docs.

Repo: https://github.com/apache/cordova-plugin-screen-orientation

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-screen-orientation
   $ npm install --save @ionic-native/screen-orientation@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS
• Windows

Usage

import { ScreenOrientation } from '@ionic-native/screen-orientation';

constructor(private screenOrientation: ScreenOrientation) { }

...


// get current
console.log(this.screenOrientation.type); // logs the current orientation, example: 'landscape'

// set to landscape
this.screenOrientation.lock(this.screenOrientation.ORIENTATIONS.LANDSCAPE);

// allow user rotate
this.screenOrientation.unlock();

// detect orientation changes
this.screenOrientation.onChange().subscribe(
   () => {
       console.log("Orientation Changed");
   }
);

Instance Members

ORIENTATIONS

Convenience enum for possible orientations

onChange()

Listen to orientation change event

lock(orientation)

Lock the orientation to the passed value. See below for accepted values

unlock()

Unlock and allow all orientations.

type

Get the current orientation of the device.

Advanced

Accepted orientation values: