@capawesome/capacitor-screen-orientation 1.1.7-dev.36f3183.1659623993

package/CapawesomeCapacitorScreenOrientation.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapawesomeCapacitorScreenOrientation'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '12.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Robin Genz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,232 @@
+<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
+<h3 align="center">Screen Orientation</h3>
+<p align="center"><strong><code>@capawesome/capacitor-screen-orientation</code></strong></p>
+<p align="center">
+  Capacitor plugin to lock/unlock the screen orientation. 
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/maintenance/yes/2022?style=flat-square" />
+  <a href="https://github.com/capawesome-team/capacitor-screen-orientation/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capawesome-team/capacitor-screen-orientation/CI/main?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capawesome/capacitor-screen-orientation"><img src="https://img.shields.io/npm/l/@capawesome/capacitor-screen-orientation?style=flat-square" /></a>
+<br>
+  <a href="https://www.npmjs.com/package/@capawesome/capacitor-screen-orientation"><img src="https://img.shields.io/npm/dw/@capawesome/capacitor-screen-orientation?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capawesome/capacitor-screen-orientation"><img src="https://img.shields.io/npm/v/@capawesome/capacitor-screen-orientation?style=flat-square" /></a>
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-1-orange?style=flat-square" /></a>
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+</p>
+
+## Maintainers
+
+| Maintainer | GitHub                                    | Social                                        |
+| ---------- | ----------------------------------------- | --------------------------------------------- |
+| Robin Genz | [robingenz](https://github.com/robingenz) | [@robin_genz](https://twitter.com/robin_genz) |
+
+## Sponsors
+
+This is an MIT-licensed open source project. 
+It can grow thanks to the support by these awesome people. 
+If you'd like to join them, please read more [here](https://github.com/sponsors/capawesome-team).  
+
+<!-- sponsors --><!-- sponsors -->
+
+## Installation
+
+```bash
+npm install @capawesome/capacitor-screen-orientation
+npx cap sync
+```
+
+### iOS
+
+On iOS you must add the following to your app's `AppDelegate.swift`:
+
+```diff
++ import CapawesomeCapacitorScreenOrientation
+
+@UIApplicationMain
+class AppDelegate: UIResponder, UIApplicationDelegate {
+
++ func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
++   return ScreenOrientation.getSupportedInterfaceOrientations()
++ }
+```
+
+## Configuration
+
+No configuration required for this plugin.
+
+## Demo
+
+A working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo)
+
+## Usage
+
+```typescript
+import { ScreenOrientation, OrientationType } from '@capawesome/capacitor-screen-orientation';
+
+const lock = async () => {
+  await ScreenOrientation.lock({ type: OrientationType.LANDSCAPE });
+};
+
+const unlock = async () => {
+  await ScreenOrientation.unlock();
+};
+
+const getCurrentOrientation = async () => {
+  const result = await ScreenOrientation.getCurrentOrientation();
+  return result.type;
+};
+```
+
+## API
+
+<docgen-index>
+
+* [`lock(...)`](#lock)
+* [`unlock()`](#unlock)
+* [`getCurrentOrientation()`](#getcurrentorientation)
+* [`addListener('screenOrientationChange', ...)`](#addlistenerscreenorientationchange)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+* [Enums](#enums)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### lock(...)
+
+```typescript
+lock(options: LockOptions) => Promise<void>
+```
+
+Locks the device orientation.
+
+| Param         | Type                                                |
+| ------------- | --------------------------------------------------- |
+| **`options`** | <code><a href="#lockoptions">LockOptions</a></code> |
+
+--------------------
+
+
+### unlock()
+
+```typescript
+unlock() => Promise<void>
+```
+
+Unlocks the device orientation.
+
+--------------------
+
+
+### getCurrentOrientation()
+
+```typescript
+getCurrentOrientation() => Promise<GetCurrentOrientationResult>
+```
+
+Gets the current device orientation type.
+
+**Returns:** <code>Promise&lt;<a href="#getcurrentorientationresult">GetCurrentOrientationResult</a>&gt;</code>
+
+--------------------
+
+
+### addListener('screenOrientationChange', ...)
+
+```typescript
+addListener(eventName: 'screenOrientationChange', listenerFunc: ScreenOrientationChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for screen orientation changes.
+
+| Param              | Type                                                                                        |
+| ------------------ | ------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'screenOrientationChange'</code>                                                      |
+| **`listenerFunc`** | <code><a href="#screenorientationchangelistener">ScreenOrientationChangeListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all listeners for this plugin.
+
+--------------------
+
+
+### Interfaces
+
+
+#### LockOptions
+
+| Prop       | Type                                                        | Description                |
+| ---------- | ----------------------------------------------------------- | -------------------------- |
+| **`type`** | <code><a href="#orientationtype">OrientationType</a></code> | The orientation lock type. |
+
+
+#### GetCurrentOrientationResult
+
+| Prop       | Type                                                        | Description                   |
+| ---------- | ----------------------------------------------------------- | ----------------------------- |
+| **`type`** | <code><a href="#orientationtype">OrientationType</a></code> | The current orientation type. |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### ScreenOrientationChange
+
+| Prop       | Type                                                        | Description                   |
+| ---------- | ----------------------------------------------------------- | ----------------------------- |
+| **`type`** | <code><a href="#orientationtype">OrientationType</a></code> | The current orientation type. |
+
+
+### Type Aliases
+
+
+#### ScreenOrientationChangeListener
+
+Callback to receive the screen orientation change notifications.
+
+<code>(change: <a href="#screenorientationchange">ScreenOrientationChange</a>): void</code>
+
+
+### Enums
+
+
+#### OrientationType
+
+| Members                   | Value                              | Description                                                         |
+| ------------------------- | ---------------------------------- | ------------------------------------------------------------------- |
+| **`LANDSCAPE`**           | <code>'landscape'</code>           | The orientation is either landscape-primary or landscape-secondary. |
+| **`LANDSCAPE_PRIMARY`**   | <code>'landscape-primary'</code>   | The orientation is in the primary landscape mode.                   |
+| **`LANDSCAPE_SECONDARY`** | <code>'landscape-secondary'</code> | The orientation is in the secondary landscape mode.                 |
+| **`PORTRAIT`**            | <code>'portrait'</code>            | The orientation is either portrait-primary or portrait-secondary.   |
+| **`PORTRAIT_PRIMARY`**    | <code>'portrait-primary'</code>    | The orientation is in the primary portrait mode.                    |
+| **`PORTRAIT_SECONDARY`**  | <code>'portrait-secondary'</code>  | The orientation is in the secondary portrait mode.                  |
+
+</docgen-api>
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-screen-orientation/blob/master/CHANGELOG.md).
+
+## License
+
+See [LICENSE](https://github.com/capawesome-team/capacitor-screen-orientation/blob/master/LICENSE).

package/android/build.gradle

@@ -0,0 +1,57 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.4.2'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:7.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_11
+        targetCompatibility JavaVersion.VERSION_11
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="io.capawesome.capacitor.screenorientation">
+</manifest>

package/android/src/main/java/io/capawesome/capacitor/screenorientation/ScreenOrientation.java

@@ -0,0 +1,87 @@
+package io.capawesome.capacitor.screenorientation;
+
+import android.content.pm.ActivityInfo;
+import android.content.res.Configuration;
+import android.view.Surface;
+import androidx.annotation.Nullable;
+import com.getcapacitor.Bridge;
+
+public class ScreenOrientation {
+
+    interface ScreenOrientationChangeListener {
+        void onScreenOrientationChanged();
+    }
+
+    @Nullable
+    private ScreenOrientationChangeListener orientationChangeListener;
+
+    @Nullable
+    private int lastOrientationConfiguration;
+
+    private Bridge bridge;
+
+    ScreenOrientation(Bridge bridge) {
+        this.bridge = bridge;
+    }
+
+    public void handleOnConfigurationChanged(Configuration newConfig) {
+        if (newConfig.orientation == lastOrientationConfiguration) {
+            return;
+        }
+        this.lastOrientationConfiguration = newConfig.orientation;
+        if (this.orientationChangeListener == null) {
+            return;
+        }
+        this.orientationChangeListener.onScreenOrientationChanged();
+    }
+
+    public void setOrientationChangeListener(@Nullable ScreenOrientationChangeListener listener) {
+        this.orientationChangeListener = listener;
+    }
+
+    @Nullable
+    public ScreenOrientationChangeListener getOrientationChangeListener() {
+        return orientationChangeListener;
+    }
+
+    public void lock(String orientationType) {
+        switch (orientationType) {
+            case ScreenOrientationType.LANDSCAPE:
+                bridge.getActivity().setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE);
+                break;
+            case ScreenOrientationType.LANDSCAPE_PRIMARY:
+                bridge.getActivity().setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE);
+                break;
+            case ScreenOrientationType.LANDSCAPE_SECONDARY:
+                bridge.getActivity().setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE);
+                break;
+            case ScreenOrientationType.PORTRAIT:
+                bridge.getActivity().setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_PORTRAIT);
+                break;
+            case ScreenOrientationType.PORTRAIT_PRIMARY:
+                bridge.getActivity().setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT);
+                break;
+            case ScreenOrientationType.PORTRAIT_SECONDARY:
+                bridge.getActivity().setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_REVERSE_PORTRAIT);
+                break;
+        }
+    }
+
+    public void unlock() {
+        bridge.getActivity().setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_USER);
+    }
+
+    public String getCurrentOrientationType() {
+        int rotation = bridge.getActivity().getWindowManager().getDefaultDisplay().getRotation();
+        switch (rotation) {
+            case Surface.ROTATION_90:
+                return ScreenOrientationType.LANDSCAPE_PRIMARY;
+            case Surface.ROTATION_180:
+                return ScreenOrientationType.PORTRAIT_SECONDARY;
+            case Surface.ROTATION_270:
+                return ScreenOrientationType.LANDSCAPE_SECONDARY;
+            default:
+                return ScreenOrientationType.PORTRAIT_PRIMARY;
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitor/screenorientation/ScreenOrientationPlugin.java

@@ -0,0 +1,56 @@
+package io.capawesome.capacitor.screenorientation;
+
+import android.content.res.Configuration;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+
+@CapacitorPlugin(name = "ScreenOrientation")
+public class ScreenOrientationPlugin extends Plugin {
+
+    public static final String SCREEN_ORIENTATION_CHANGE_EVENT = "screenOrientationChange";
+
+    private ScreenOrientation implementation;
+
+    @Override
+    public void load() {
+        implementation = new ScreenOrientation(getBridge());
+        implementation.setOrientationChangeListener(this::updateOrientation);
+    }
+
+    @Override
+    public void handleOnConfigurationChanged(Configuration newConfig) {
+        super.handleOnConfigurationChanged(newConfig);
+        implementation.handleOnConfigurationChanged(newConfig);
+    }
+
+    @PluginMethod
+    public void lock(PluginCall call) {
+        String orientationType = call.getString("type");
+        implementation.lock(orientationType);
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void unlock(PluginCall call) {
+        implementation.unlock();
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void getCurrentOrientation(PluginCall call) {
+        JSObject ret = new JSObject();
+        String orientationType = implementation.getCurrentOrientationType();
+        ret.put("type", orientationType);
+        call.resolve(ret);
+    }
+
+    private void updateOrientation() {
+        JSObject ret = new JSObject();
+        String orientationType = implementation.getCurrentOrientationType();
+        ret.put("type", orientationType);
+        notifyListeners(SCREEN_ORIENTATION_CHANGE_EVENT, ret);
+    }
+}

package/android/src/main/java/io/capawesome/capacitor/screenorientation/ScreenOrientationType.java

@@ -0,0 +1,11 @@
+package io.capawesome.capacitor.screenorientation;
+
+public class ScreenOrientationType {
+
+    public static final String LANDSCAPE = "landscape";
+    public static final String LANDSCAPE_PRIMARY = "landscape-primary";
+    public static final String LANDSCAPE_SECONDARY = "landscape-secondary";
+    public static final String PORTRAIT = "portrait";
+    public static final String PORTRAIT_PRIMARY = "portrait-primary";
+    public static final String PORTRAIT_SECONDARY = "portrait-secondary";
+}