Back to Content

Screen: orientation property

files/en-us/web/api/screen/orientation/index.md

latest1.1 KB
Original Source

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

The orientation read-only property of the {{DOMxRef("Screen")}} interface returns the current orientation of the screen.

Value

An instance of {{DOMxRef("ScreenOrientation")}} representing the orientation of the screen.

Note that older, prefixed versions returned a string equivalent to {{DOMxRef("ScreenOrientation.type")}}.

Examples

js
switch (screen.orientation.type) {
  case "landscape-primary":
    console.log("That looks good.");
    break;
  case "landscape-secondary":
    console.log("Mmm… the screen is upside down!");
    break;
  case "portrait-secondary":
  case "portrait-primary":
    console.log("Mmm… you should rotate your device to landscape");
    break;
  default:
    console.log("The orientation API isn't supported in this browser :(");
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

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