@tenthdart/react-native-nitro-orientation-locker 0.0.1

package/nitrogen/generated/shared/c++/HybridOrientationLockerSpec.cpp

@@ -0,0 +1,25 @@
+///
+/// HybridOrientationLockerSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "HybridOrientationLockerSpec.hpp"
+
+namespace margelo::nitro::orientationlocker {
+
+  void HybridOrientationLockerSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridGetter("isTablet", &HybridOrientationLockerSpec::getIsTablet);
+      prototype.registerHybridGetter("currentOrientation", &HybridOrientationLockerSpec::getCurrentOrientation);
+      prototype.registerHybridMethod("acquireLock", &HybridOrientationLockerSpec::acquireLock);
+      prototype.registerHybridMethod("releaseLock", &HybridOrientationLockerSpec::releaseLock);
+      prototype.registerHybridMethod("setLockTabletsToLandscape", &HybridOrientationLockerSpec::setLockTabletsToLandscape);
+    });
+  }
+
+} // namespace margelo::nitro::orientationlocker

package/nitrogen/generated/shared/c++/HybridOrientationLockerSpec.hpp

@@ -0,0 +1,66 @@
+///
+/// HybridOrientationLockerSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `Orientation` to properly resolve imports.
+namespace margelo::nitro::orientationlocker { enum class Orientation; }
+
+#include "Orientation.hpp"
+
+namespace margelo::nitro::orientationlocker {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `OrientationLocker`
+   * Inherit this class to create instances of `HybridOrientationLockerSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridOrientationLocker: public HybridOrientationLockerSpec {
+   * public:
+   *   HybridOrientationLocker(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridOrientationLockerSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridOrientationLockerSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridOrientationLockerSpec() override = default;
+
+    public:
+      // Properties
+      virtual bool getIsTablet() = 0;
+      virtual Orientation getCurrentOrientation() = 0;
+
+    public:
+      // Methods
+      virtual void acquireLock(Orientation orientation) = 0;
+      virtual void releaseLock() = 0;
+      virtual void setLockTabletsToLandscape(bool enabled) = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "OrientationLocker";
+  };
+
+} // namespace margelo::nitro::orientationlocker

package/nitrogen/generated/shared/c++/Orientation.hpp

@@ -0,0 +1,92 @@
+///
+/// Orientation.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/NitroHash.hpp>)
+#include <NitroModules/NitroHash.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+namespace margelo::nitro::orientationlocker {
+
+  /**
+   * An enum which can be represented as a JavaScript union (Orientation).
+   */
+  enum class Orientation {
+    PORTRAIT      SWIFT_NAME(portrait) = 0,
+    PORTRAIT_UPSIDE_DOWN      SWIFT_NAME(portraitUpsideDown) = 1,
+    LANDSCAPE_LEFT      SWIFT_NAME(landscapeLeft) = 2,
+    LANDSCAPE_RIGHT      SWIFT_NAME(landscapeRight) = 3,
+    LANDSCAPE      SWIFT_NAME(landscape) = 4,
+    ALL      SWIFT_NAME(all) = 5,
+  } CLOSED_ENUM;
+
+} // namespace margelo::nitro::orientationlocker
+
+namespace margelo::nitro {
+
+  // C++ Orientation <> JS Orientation (union)
+  template <>
+  struct JSIConverter<margelo::nitro::orientationlocker::Orientation> final {
+    static inline margelo::nitro::orientationlocker::Orientation fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, arg);
+      switch (hashString(unionValue.c_str(), unionValue.size())) {
+        case hashString("portrait"): return margelo::nitro::orientationlocker::Orientation::PORTRAIT;
+        case hashString("portrait-upside-down"): return margelo::nitro::orientationlocker::Orientation::PORTRAIT_UPSIDE_DOWN;
+        case hashString("landscape-left"): return margelo::nitro::orientationlocker::Orientation::LANDSCAPE_LEFT;
+        case hashString("landscape-right"): return margelo::nitro::orientationlocker::Orientation::LANDSCAPE_RIGHT;
+        case hashString("landscape"): return margelo::nitro::orientationlocker::Orientation::LANDSCAPE;
+        case hashString("all"): return margelo::nitro::orientationlocker::Orientation::ALL;
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert \"" + unionValue + "\" to enum Orientation - invalid value!");
+      }
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, margelo::nitro::orientationlocker::Orientation arg) {
+      switch (arg) {
+        case margelo::nitro::orientationlocker::Orientation::PORTRAIT: return JSIConverter<std::string>::toJSI(runtime, "portrait");
+        case margelo::nitro::orientationlocker::Orientation::PORTRAIT_UPSIDE_DOWN: return JSIConverter<std::string>::toJSI(runtime, "portrait-upside-down");
+        case margelo::nitro::orientationlocker::Orientation::LANDSCAPE_LEFT: return JSIConverter<std::string>::toJSI(runtime, "landscape-left");
+        case margelo::nitro::orientationlocker::Orientation::LANDSCAPE_RIGHT: return JSIConverter<std::string>::toJSI(runtime, "landscape-right");
+        case margelo::nitro::orientationlocker::Orientation::LANDSCAPE: return JSIConverter<std::string>::toJSI(runtime, "landscape");
+        case margelo::nitro::orientationlocker::Orientation::ALL: return JSIConverter<std::string>::toJSI(runtime, "all");
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert Orientation to JS - invalid value: "
+                                    + std::to_string(static_cast<int>(arg)) + "!");
+      }
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isString()) {
+        return false;
+      }
+      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, value);
+      switch (hashString(unionValue.c_str(), unionValue.size())) {
+        case hashString("portrait"):
+        case hashString("portrait-upside-down"):
+        case hashString("landscape-left"):
+        case hashString("landscape-right"):
+        case hashString("landscape"):
+        case hashString("all"):
+          return true;
+        default:
+          return false;
+      }
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@tenthdart/react-native-nitro-orientation-locker",
+  "version": "0.0.1",
+  "description": "High-performance Nitro module for locking screen orientation on React Native (New Architecture only).",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "types": "./lib/typescript/index.d.ts",
+  "react-native": "./src/index.ts",
+  "source": "./src/index.ts",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "nitrogen/generated",
+    "NitroOrientationLocker.podspec",
+    "react-native.config.js",
+    "nitro.json",
+    "README.md",
+    "LICENSE",
+    "!**/.DS_Store",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!ios/build",
+    "!android/build",
+    "!android/.gradle",
+    "!android/.cxx",
+    "!**/*.tsbuildinfo"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "specs": "nitrogen",
+    "clean": "rimraf lib nitrogen/generated",
+    "build": "bob build",
+    "prepare": "bob build",
+    "prepublishOnly": "bob build"
+  },
+  "keywords": [
+    "react-native",
+    "nitro",
+    "nitro-modules",
+    "orientation",
+    "orientation-locker",
+    "landscape",
+    "portrait",
+    "tablet",
+    "ios",
+    "android",
+    "visionos"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tenthdart/react-native-nitro-orientation-locker.git"
+  },
+  "homepage": "https://github.com/tenthdart/react-native-nitro-orientation-locker#readme",
+  "bugs": {
+    "url": "https://github.com/tenthdart/react-native-nitro-orientation-locker/issues"
+  },
+  "author": {
+    "name": "Tenthdart",
+    "email": "ar.372920118@gmail.com",
+    "url": "https://github.com/tenthdart"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">= 18.0.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": ">=0.76.0",
+    "react-native-nitro-modules": ">=0.22.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.0",
+    "nitrogen": "^0.35.0",
+    "react": "19.1.0",
+    "react-native": "0.81.0",
+    "react-native-builder-bob": "^0.40.0",
+    "react-native-nitro-modules": "^0.35.0",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.0"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  }
+}

package/react-native.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  dependency: {
+    platforms: {
+      ios: {},
+      android: {},
+    },
+  },
+};

package/src/OrientationLocker.nitro.ts

@@ -0,0 +1,45 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export type Orientation =
+  | 'portrait'
+  | 'portrait-upside-down'
+  | 'landscape-left'
+  | 'landscape-right'
+  | 'landscape'
+  | 'all';
+
+export interface OrientationLocker
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  /**
+   * True when the device's smallest width is >= 600dp (Android)
+   * or the user-interface idiom is .pad (iOS / visionOS).
+   */
+  readonly isTablet: boolean;
+
+  /**
+   * The current effective orientation of the interface.
+   */
+  readonly currentOrientation: Orientation;
+
+  /**
+   * Force a given orientation. Subsequent calls override the previous lock.
+   * On iOS 16+, this uses `requestGeometryUpdate`. On Android, it sets the
+   * Activity's requested orientation. The lock persists until `releaseLock`
+   * is called.
+   */
+  acquireLock(orientation: Orientation): void;
+
+  /**
+   * Release any active lock and return to the app's default supported
+   * orientations.
+   */
+  releaseLock(): void;
+
+  /**
+   * Enable or disable automatic landscape lock for tablets / large-width
+   * screens. When enabled and the device is a tablet, this acquires a
+   * landscape lock immediately. When disabled, any tablet-driven lock is
+   * released (manual locks set via `acquireLock` are untouched).
+   */
+  setLockTabletsToLandscape(enabled: boolean): void;
+}

package/src/OrientationLockerProvider.tsx

@@ -0,0 +1,26 @@
+import React, { useEffect } from 'react';
+import { OrientationLocker } from './index';
+
+export interface OrientationLockerProviderProps {
+  /**
+   * When true, devices with `isTablet === true` (iPad / visionOS / Android
+   * `smallestScreenWidthDp >= 600`) are locked to landscape automatically
+   * while the provider is mounted. Phones are unaffected.
+   */
+  lockTabletsToLandscape?: boolean;
+  children?: React.ReactNode;
+}
+
+export function OrientationLockerProvider({
+  lockTabletsToLandscape = false,
+  children,
+}: OrientationLockerProviderProps): React.ReactElement {
+  useEffect(() => {
+    OrientationLocker.setLockTabletsToLandscape(lockTabletsToLandscape);
+    return () => {
+      OrientationLocker.setLockTabletsToLandscape(false);
+    };
+  }, [lockTabletsToLandscape]);
+
+  return <>{children}</>;
+}

package/src/index.ts

@@ -0,0 +1,30 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import type {
+  OrientationLocker as OrientationLockerSpec,
+  Orientation,
+} from './OrientationLocker.nitro';
+
+export type { Orientation } from './OrientationLocker.nitro';
+
+const OrientationLockerHybrid =
+  NitroModules.createHybridObject<OrientationLockerSpec>('OrientationLocker');
+
+export const OrientationLocker = {
+  get isTablet(): boolean {
+    return OrientationLockerHybrid.isTablet;
+  },
+  get currentOrientation(): Orientation {
+    return OrientationLockerHybrid.currentOrientation;
+  },
+  acquireLock(orientation: Orientation): void {
+    OrientationLockerHybrid.acquireLock(orientation);
+  },
+  releaseLock(): void {
+    OrientationLockerHybrid.releaseLock();
+  },
+  setLockTabletsToLandscape(enabled: boolean): void {
+    OrientationLockerHybrid.setLockTabletsToLandscape(enabled);
+  },
+};
+
+export { OrientationLockerProvider } from './OrientationLockerProvider';