Screen: unlockOrientation() method

{{APIRef("Screen Orientation API")}}{{Deprecated_Header}}

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

[!WARNING] This feature is deprecated and should be avoided. Use the {{DOMxRef("ScreenOrientation.unlock()")}} method instead.

[!NOTE] This method only works for installed Web apps or for Web pages in fullscreen mode.

Syntax

unlockOrientation()

Parameters

None.

Return value

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

Examples

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 {{domxref("ScreenOrientation.unlock()")}} instead.

Browser compatibility

{{Compat}}

See also

• {{DOMxRef("Screen.orientation")}}
• {{DOMxRef("Screen.lockOrientation()")}}
• {{DOMxRef("Screen.orientationchange_event", "orientationchange")}} event
• Managing screen orientation