Screen.unlockOrientation()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Screen.unlockOrientation method removes all the previous screen locks set by the page/app.

Note: This method only works for installed Web apps or for Web pages in full-screen mode.

Syntax

var unlocked = window.screen.unlockOrientation();

Return value

Returns true if the orientation was successfully unlocked or false if the orientation couldn't be unlocked.

Example

var unlockOrientation = screen.unlockOrientation || screen.mozUnlockOrientation || screen.msUnlockOrientation || (screen.orientation && screen.orientation.unlock);

if (unlockOrientation()) {
  // orientation was unlocked
} else {
  // orientation unlock failed
}

Specifications

Specification Status Comment
Screen Orientation API
The definition of 'Screen Orientation' in that specification.
Working Draft Draft specification

Browser compatibility

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support No support (Yes) moz[1] 11 ms[2] No support No support
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support No support (Yes)[3] (Yes) moz[1] No support No support No support

[1] This API is currently in draft form. It is only implemented as a prefixed method (mozUnlockOrientation) in B2G and Firefox for Android.

[2] This API is implemented using a prefix (msUnlockOrientation) in Internet Explorer for Windows 8.1 and Windows RT 8.1. It is not supported on Windows 7.

[3] This API is implemented with the draft version that uses the window.screen.orientation.lock / window.screen.orientation.unlock syntax

See also

Document Tags and Contributors

 Contributors to this page: avgp, Sebastianz, teoli, dstorey, kscarfone, Prachi_Dighe, justinpotts, Jeremie
 Last updated by: avgp,