github/cordova-plugin-screen-orientation

mirror of https://github.com/apache/cordova-plugin-screen-orientation.git synced 2024-10-06 14:42:11 +08:00

Grant Benvenuti 37b6ff8359 Added initial readme and cleanup of old code.

2014-05-07 08:02:25 +10:00

1.4 KiB

Raw Blame History

cordova-yoik-screenorientation

Cordova plugin to set/lock the screen orientation in a common way for both iOS and Android.

Android

The android version is implemented via the standard activity.setRequestedOrientation as used in other screen orientation plugins

iOS

The iOS version is a combination of the cordova JS callback window.shouldRotateToOrientation and the workaround to recheck the orientation as implemented in https://github.com/Adlotto/cordova-plugin-recheck-screen-orientation.

If you have a custom impelemntation of the window.shouldRotateToOrientation it will have to be removed for the plugin to function as expected.

Constants

Orientation: {
    UNSPECIFIED: "unspecified",
    LANDSCAPE: "landscape",
    PORTRAIT: "portrait",
    USER: "user",
    BEHIND: "behind",
    SENSOR: "sensor",
    NOSENSOR: "nosensor",
    SENSOR_LANDSCAPE: "sensorLandscape",
    SENSOR_PORTRAIT: "sensorPortrait",
    REVERSE_LANDSCAPE: "reverseLandscape",
    REVERSE_PORTRAIT: "reversePortrait",
    FULL_SENSOR: "fullSensor"
}

Usage

var so = cordova.plugins.screenorientation;

// with callbacks
so.setOrientation(successCallback, errorCallback, so.Orientation.PORTRAIT);

// no callbacks
so.setOrientation(so.Orientation.SENSOR_LANDSCAPE);