@capawesome/capacitor-screen-orientation
Capacitor plugin to lock/unlock the screen orientation.
Installation
npm install @capawesome/capacitor-screen-orientation
npx cap sync
iOS
On iOS you must add the following to your app's AppDelegate.swift
:
+ 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
Usage
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
lock(...)
lock(options: LockOptions) => Promise<void>
Locks the device orientation.
unlock()
unlock() => Promise<void>
Unlocks the device orientation.
getCurrentOrientation()
getCurrentOrientation() => Promise<GetCurrentOrientationResult>
Gets the current device orientation type.
Returns: Promise<GetCurrentOrientationResult>
addListener('screenOrientationChange', ...)
addListener(eventName: 'screenOrientationChange', listenerFunc: ScreenOrientationChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
Listen for screen orientation changes.
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
removeAllListeners()
removeAllListeners() => Promise<void>
Remove all listeners for this plugin.
Interfaces
LockOptions
GetCurrentOrientationResult
PluginListenerHandle
Prop | Type |
---|
remove | () => Promise<void> |
ScreenOrientationChange
Type Aliases
ScreenOrientationChangeListener
Callback to receive the screen orientation change notifications.
(change: ScreenOrientationChange): void
Enums
OrientationType
Members | Value | Description |
---|
LANDSCAPE | 'landscape' | The orientation is either landscape-primary or landscape-secondary. |
LANDSCAPE_PRIMARY | 'landscape-primary' | The orientation is in the primary landscape mode. |
LANDSCAPE_SECONDARY | 'landscape-secondary' | The orientation is in the secondary landscape mode. |
PORTRAIT | 'portrait' | The orientation is either portrait-primary or portrait-secondary. |
PORTRAIT_PRIMARY | 'portrait-primary' | The orientation is in the primary portrait mode. |
PORTRAIT_SECONDARY | 'portrait-secondary' | The orientation is in the secondary portrait mode. |
Changelog
See CHANGELOG.md.
License
See LICENSE.
Credits
This plugin is based on the Capacitor Screen Orientation plugin.
Thanks to everyone who contributed to the project!