diff --git a/screen-orientation/README.md b/screen-orientation/README.md index 056b05d40..d9cb3e8fd 100644 --- a/screen-orientation/README.md +++ b/screen-orientation/README.md @@ -39,6 +39,7 @@ By default, an iPad allows Multitasking and its orientation cannot be locked. If * [`addListener('screenOrientationChange', ...)`](#addlistenerscreenorientationchange) * [`removeAllListeners()`](#removealllisteners) * [Interfaces](#interfaces) +* [Type Aliases](#type-aliases) @@ -135,9 +136,9 @@ Removes all listeners. #### OrientationLockOptions -| Prop | Type | -| ----------------- | -------------------------------- | -| **`orientation`** | OrientationLockType | +| Prop | Type | Description | +| ----------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| **`orientation`** | OrientationLockType | Note: Typescript v5.2+ users should import OrientationLockType from @capacitor/screen-orientation. | #### PluginListenerHandle @@ -146,4 +147,12 @@ Removes all listeners. | ------------ | ----------------------------------------- | | **`remove`** | () => Promise<void> | + +### Type Aliases + + +#### OrientationLockType + +'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary' + diff --git a/screen-orientation/src/definitions.ts b/screen-orientation/src/definitions.ts index af3ac5cc1..da041e040 100644 --- a/screen-orientation/src/definitions.ts +++ b/screen-orientation/src/definitions.ts @@ -1,9 +1,22 @@ import type { PluginListenerHandle } from '@capacitor/core'; export interface OrientationLockOptions { + /** + * Note: Typescript v5.2+ users should import OrientationLockType from @capacitor/screen-orientation. + */ orientation: OrientationLockType; } +export type OrientationLockType = + | 'any' + | 'natural' + | 'landscape' + | 'portrait' + | 'portrait-primary' + | 'portrait-secondary' + | 'landscape-primary' + | 'landscape-secondary'; + export interface ScreenOrientationResult { type: OrientationType; }