@capacitor/screen-orientation

Screen Orientation API 提供了与屏幕方向相关的信息和功能。

安装

npm install @capacitor/screen-orientation@latest-7
npx cap sync

iOS

锁定屏幕方向仅对 Capacitor 的 View Controller 生效，不会影响其他已呈现的 View Controller（例如 Browser 插件所呈现的控制器）。 如需同时锁定已呈现的 View Controller，可以将以下代码添加到应用的 AppDelegate.swift 文件中：

func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
  return UIInterfaceOrientationMask(rawValue: (self.window!.rootViewController as! CAPBridgeViewController).supportedInterfaceOrientations.rawValue)
}

iPad 方向锁定

默认情况下，iPad 允许多任务处理，且其方向无法被锁定。若需在 iPad 上锁定方向，请将 Requires Full Screen 选项设为 YES，即在 Info.plist 中添加以下配置：

  <key>UIRequiresFullScreen</key>
  <true/>

API

• orientation()
• lock(...)
• unlock()
• addListener('screenOrientationChange', ...)
• removeAllListeners()
• 接口
• 类型别名

orientation()

orientation() => Promise<ScreenOrientationResult>

返回当前屏幕方向。

返回值：

Promise<ScreenOrientationResult>

自版本： 4.0.0

---

lock(...)

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

锁定屏幕方向。

参数	类型
options	OrientationLockOptions

自版本： 4.0.0

---

unlock()

unlock() => Promise<void>

解除屏幕方向的锁定。

自版本： 4.0.0

---

addListener('screenOrientationChange', ...)

addListener(eventName: 'screenOrientationChange', listenerFunc: (orientation: ScreenOrientationResult) => void) => Promise<PluginListenerHandle>

监听屏幕方向变化。

参数	类型
eventName	'screenOrientationChange'
listenerFunc	(orientation: ScreenOrientationResult) => void

返回值：

Promise<PluginListenerHandle>

自版本： 4.0.0

---

removeAllListeners()

removeAllListeners() => Promise<void>

移除所有监听器。

自版本： 4.0.0

---

接口

ScreenOrientationResult

属性	类型
type	OrientationType

OrientationLockOptions

属性	类型	说明
orientation	OrientationLockType	注意：TypeScript v5.2+ 用户应从 @capacitor/screen-orientation 导入 OrientationLockType 类型。

PluginListenerHandle

属性	类型
remove	() => Promise<void>

类型别名

OrientationLockType

'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary'