@capawesome/capacitor-screen-orientation

Screen Orientation

@capawesome/capacitor-screen-orientation

Capacitor plugin to lock/unlock the screen orientation.

Maintainers

Maintainer	GitHub	Social
Robin Genz	robingenz	@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.

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(...)
• unlock()
• getCurrentOrientation()
• addListener('screenOrientationChange', ...)
• removeAllListeners()
• Interfaces
• Type Aliases
• Enums

lock(...)

lock(options: LockOptions) => Promise<void>

Locks the device orientation.

Param	Type
options	LockOptions

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.

Param	Type
eventName	'screenOrientationChange'
listenerFunc	ScreenOrientationChangeListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Interfaces

LockOptions

Prop	Type	Description
type	OrientationType	The orientation lock type.

GetCurrentOrientationResult

Prop	Type	Description
type	OrientationType	The current orientation type.

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

ScreenOrientationChange

Prop	Type	Description
type	OrientationType	The current orientation type.

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.