Screen: unlockOrientation() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The Screen.unlockOrientation() method removes all the previous screen locks set by the page/app. The ScreenOrientation.unlock() method should be used instead.

Warning: This feature is deprecated and should be avoided. Use the ScreenOrientation.unlock() method instead.

Note: This method only works for installed Web apps or for Web pages in fullscreen mode.

Syntax

js

unlockOrientation()

Parameters

None.

Return value

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

Examples

js

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

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

Specifications

This feature is not part of any specification. It is no longer on track to becoming a standard.

Use ScreenOrientation.unlock() instead.

Browser compatibility

BCD tables only load in the browser

See also