diff options
Diffstat (limited to 'plugins/com.phonegap.plugins.OrientationLock/README.md')
| -rw-r--r-- | plugins/com.phonegap.plugins.OrientationLock/README.md | 29 |
1 files changed, 0 insertions, 29 deletions
diff --git a/plugins/com.phonegap.plugins.OrientationLock/README.md b/plugins/com.phonegap.plugins.OrientationLock/README.md deleted file mode 100644 index 6a5899ed..00000000 --- a/plugins/com.phonegap.plugins.OrientationLock/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# OrientationLock # - -Android Cordova plugin for locking/unlocking the screen orientation from Javascript - -## Calling the plugin ## - -From your JavaScript code call -`window.plugins.orientationLock.unlock()` to unlock orientation, -`window.plugins.orientationLock.lock("portrait")` or `window.plugins.orientationLock.lock("landscape")` -to lock your screen to the specified orientation. - -To start your Cordova application pre-locked place -`setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT);` or -`setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE);` -in the `onCreate()` of your Cordova activity. - -Once unlocked, you can track orientation changes with the regular `orientationchange` event: - - window.addEventListener("orientationchange", function() { - alert(window.orientation); - }); - -## Adding the Plugin to your project ## - -Using this plugin requires [Apache Cordova for Android](https://github.com/apache/cordova-android). -Within your project, run the following command: - - cordova plugin add https://github.com/cogitor/PhoneGap-OrientationLock.git - |