fix(screen-orientation): Add OrientationLockType (#1914)

Co-authored-by: Dan Giralté <[email protected]> Co-authored-by: jcesarmobile <[email protected]>
ionic-team · Jan 23, 2024 · 0871a73 · 0871a73
1 parent e2cdf35
commit 0871a73
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git 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)
 
 </docgen-index>
 
@@ -135,9 +136,9 @@ Removes all listeners.
 
 #### OrientationLockOptions
 
-| Prop              | Type                             |
-| ----------------- | -------------------------------- |
-| **`orientation`** | <code>OrientationLockType</code> |
+| Prop              | Type                                                                | Description                                                                                                                           |
+| ----------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| **`orientation`** | <code><a href="#orientationlocktype">OrientationLockType</a></code> | Note: Typescript v5.2+ users should import <a href="#orientationlocktype">OrientationLockType</a> from @capacitor/screen-orientation. |
 
 
 #### PluginListenerHandle
@@ -146,4 +147,12 @@ Removes all listeners.
 | ------------ | ----------------------------------------- |
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
+
+### Type Aliases
+
+
+#### OrientationLockType
+
+<code>'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary'</code>
+
 </docgen-api>
diff --git 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;
 }