@capgo/capacitor-screen-orientation 8.1.21 → 8.2.0

package/dist/docs.json

@@ -176,50 +176,252 @@
         ],
         "slug": "isorientationlocked"
       },
+      {
+        "name": "isDeviceFoldable",
+        "signature": "() => Promise<DeviceFoldableResult>",
+        "parameters": [],
+        "returns": "Promise<DeviceFoldableResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          },
+          {
+            "name": "returns",
+            "text": "Fold capability of this device."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { foldable, supportsTabletop } = await ScreenOrientation.isDeviceFoldable();\n```"
+          }
+        ],
+        "docs": "Whether this device folds, and whether it can stand half-open like a laptop.\n\nBoth flags are `false` on web and iOS.",
+        "complexTypes": [
+          "DeviceFoldableResult"
+        ],
+        "slug": "isdevicefoldable"
+      },
+      {
+        "name": "getFoldState",
+        "signature": "() => Promise<FoldState>",
+        "parameters": [],
+        "returns": "Promise<FoldState>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          },
+          {
+            "name": "returns",
+            "text": "The current fold state."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { posture, hingeOrientation } = await ScreenOrientation.getFoldState();\n```"
+          }
+        ],
+        "docs": "Read the current fold.\n\nResolves to a flat state when the device has no fold.",
+        "complexTypes": [
+          "FoldState"
+        ],
+        "slug": "getfoldstate"
+      },
+      {
+        "name": "getHingeAngle",
+        "signature": "() => Promise<HingeAngleResult>",
+        "parameters": [],
+        "returns": "Promise<HingeAngleResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          },
+          {
+            "name": "returns",
+            "text": "The latest hinge angle."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { angle } = await ScreenOrientation.getHingeAngle();\n```"
+          }
+        ],
+        "docs": "Read the hinge angle in degrees.\n\n`0` is closed and `180` is flat. `angle` is `null` without a hinge sensor.",
+        "complexTypes": [
+          "HingeAngleResult"
+        ],
+        "slug": "gethingeangle"
+      },
+      {
+        "name": "getSizeClass",
+        "signature": "() => Promise<SizeClass>",
+        "parameters": [],
+        "returns": "Promise<SizeClass>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          },
+          {
+            "name": "returns",
+            "text": "Apple and Material size classes for the current window."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { horizontal, widthClass } = await ScreenOrientation.getSizeClass();\n```"
+          }
+        ],
+        "docs": "Read the window size classes.",
+        "complexTypes": [
+          "SizeClass"
+        ],
+        "slug": "getsizeclass"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: 'screenOrientationChange', listenerFunc: (result: ScreenOrientationResult) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
-            "docs": "The event name. Must be 'screenOrientationChange'.",
+            "docs": "",
             "type": "'screenOrientationChange'"
           },
           {
             "name": "listenerFunc",
-            "docs": "Callback function invoked when orientation changes.",
+            "docs": "",
             "type": "(result: ScreenOrientationResult) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ScreenOrientationResult"
+        ],
+        "slug": "addlistenerscreenorientationchange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'foldStateChange', listenerFunc: (state: FoldState) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The event name. Must be 'foldStateChange'.",
+            "type": "'foldStateChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "Callback invoked with the new fold state.",
+            "type": "(state: FoldState) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "since",
-            "text": "1.0.0"
+            "text": "8.2.0"
           },
           {
             "name": "param",
-            "text": "eventName The event name. Must be 'screenOrientationChange'."
+            "text": "eventName The event name. Must be 'foldStateChange'."
           },
           {
             "name": "param",
-            "text": "listenerFunc Callback function invoked when orientation changes."
+            "text": "listenerFunc Callback invoked with the new fold state."
           },
           {
             "name": "returns",
             "text": "A promise that resolves to a listener handle."
+          }
+        ],
+        "docs": "Listen for fold changes.\n\nOn a foldable this also fires when the device rotates, because the hinge\nbounds rotate with the window.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "FoldState"
+        ],
+        "slug": "addlistenerfoldstatechange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'hingeAngleChange', listenerFunc: (event: HingeAngleResult) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The event name. Must be 'hingeAngleChange'.",
+            "type": "'hingeAngleChange'"
           },
           {
-            "name": "example",
-            "text": "```typescript\nconst listener = await ScreenOrientation.addListener(\n  'screenOrientationChange',\n  (result) => {\n    console.log('New orientation:', result.type);\n  }\n);\n\n// To remove the listener:\nawait listener.remove();\n```"
+            "name": "listenerFunc",
+            "docs": "Callback invoked with the angle in degrees.",
+            "type": "(event: HingeAngleResult) => void"
           }
         ],
-        "docs": "Listen for screen orientation changes.\n\nRegisters a listener that will be called whenever the screen orientation changes.\nIf motion-based tracking is enabled, this will also fire for orientation changes\ndetected by motion sensors even when orientation lock is enabled.",
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          },
+          {
+            "name": "param",
+            "text": "eventName The event name. Must be 'hingeAngleChange'."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc Callback invoked with the angle in degrees."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves to a listener handle."
+          }
+        ],
+        "docs": "Listen for hinge angle changes.\n\nOn Android the hinge sensor runs only while at least one listener is registered.\nNever fires on web or iOS.",
         "complexTypes": [
           "PluginListenerHandle",
-          "ScreenOrientationResult"
+          "HingeAngleResult"
         ],
-        "slug": "addlistenerscreenorientationchange-"
+        "slug": "addlistenerhingeanglechange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'sizeClassChange', listenerFunc: (sizeClass: SizeClass) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The event name. Must be 'sizeClassChange'.",
+            "type": "'sizeClassChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "Callback invoked with the new size class.",
+            "type": "(sizeClass: SizeClass) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          },
+          {
+            "name": "param",
+            "text": "eventName The event name. Must be 'sizeClassChange'."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc Callback invoked with the new size class."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves to a listener handle."
+          }
+        ],
+        "docs": "Listen for size class changes, such as unfolding, rotating, or resizing.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "SizeClass"
+        ],
+        "slug": "addlistenersizeclasschange-"
       },
       {
         "name": "removeAllListeners",
@@ -427,6 +629,270 @@
         }
       ]
     },
+    {
+      "name": "DeviceFoldableResult",
+      "slug": "devicefoldableresult",
+      "docs": "Whether this device can fold.",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "foldable",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the device has a fold.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "supportsTabletop",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether it can stand half-open like a laptop.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "FoldState",
+      "slug": "foldstate",
+      "docs": "Current fold of the window.\n\nPhones that do not fold, iOS, and web resolve to a flat state.",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "state",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Posture of the fold.",
+          "complexTypes": [
+            "FoldStateValue"
+          ],
+          "type": "FoldStateValue"
+        },
+        {
+          "name": "isSeparating",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the fold splits the web view into two areas.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "posture",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "How the device is held.",
+          "complexTypes": [
+            "FoldPosture"
+          ],
+          "type": "FoldPosture"
+        },
+        {
+          "name": "hingeOrientation",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Direction of the hinge. Omitted when there is no fold.",
+          "complexTypes": [
+            "HingeOrientation"
+          ],
+          "type": "HingeOrientation"
+        },
+        {
+          "name": "hingeBounds",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Position of the fold in CSS pixels. Omitted when there is no fold.",
+          "complexTypes": [
+            "FoldBounds"
+          ],
+          "type": "FoldBounds"
+        },
+        {
+          "name": "occludedBounds",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Area the hinge covers. Present when the hinge has a physical gap.",
+          "complexTypes": [
+            "FoldBounds"
+          ],
+          "type": "FoldBounds"
+        }
+      ]
+    },
+    {
+      "name": "FoldBounds",
+      "slug": "foldbounds",
+      "docs": "A rectangle in CSS pixels, relative to the web view.",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "x",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "y",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "width",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "height",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "HingeAngleResult",
+      "slug": "hingeangleresult",
+      "docs": "Angle between the two halves of a foldable, in degrees.\n\n`0` is closed and `180` is flat. `angle` is `null` when the device has no hinge sensor.",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "angle",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Hinge angle in degrees, or `null` when no sensor is available.",
+          "complexTypes": [],
+          "type": "number | null"
+        }
+      ]
+    },
+    {
+      "name": "SizeClass",
+      "slug": "sizeclass",
+      "docs": "Window size classes.\n\n`horizontal` and `vertical` follow Apple's compact/regular split.\nOn Android and web, `regular` starts at 600 CSS pixels wide and 480 tall.\n`widthClass` and `heightClass` follow Material window size classes.",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "horizontal",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Width size class. `compact` on a phone, `regular` on the inner display of a foldable, a tablet, or a window at least 600 CSS pixels wide.",
+          "complexTypes": [],
+          "type": "'compact' | 'regular'"
+        },
+        {
+          "name": "vertical",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Height size class. `regular` starts at 480 CSS pixels.",
+          "complexTypes": [],
+          "type": "'compact' | 'regular'"
+        },
+        {
+          "name": "widthClass",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Material window width class.",
+          "complexTypes": [],
+          "type": "'compact' | 'medium' | 'expanded' | 'large' | 'extraLarge'"
+        },
+        {
+          "name": "heightClass",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Material window height class.",
+          "complexTypes": [],
+          "type": "'compact' | 'medium' | 'expanded'"
+        }
+      ]
+    },
     {
       "name": "PluginListenerHandle",
       "slug": "pluginlistenerhandle",
@@ -507,6 +973,55 @@
           "complexTypes": []
         }
       ]
+    },
+    {
+      "name": "FoldStateValue",
+      "slug": "foldstatevalue",
+      "docs": "How open a foldable is.\n\n`closed` is reserved. A device shut onto its cover display reports `flat`.",
+      "types": [
+        {
+          "text": "'flat'",
+          "complexTypes": []
+        },
+        {
+          "text": "'half-opened'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "FoldPosture",
+      "slug": "foldposture",
+      "docs": "How a half-open foldable is held.\n\n`tabletop` is a horizontal hinge, like a laptop. `book` is a vertical hinge.",
+      "types": [
+        {
+          "text": "'flat'",
+          "complexTypes": []
+        },
+        {
+          "text": "'tabletop'",
+          "complexTypes": []
+        },
+        {
+          "text": "'book'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "HingeOrientation",
+      "slug": "hingeorientation",
+      "docs": "Direction of the hinge relative to the window.",
+      "types": [
+        {
+          "text": "'horizontal'",
+          "complexTypes": []
+        },
+        {
+          "text": "'vertical'",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": []