@onekeyfe/react-native-scroll-guard 0.1.1

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

@@ -0,0 +1,80 @@
+///
+/// ScrollGuardDirection.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 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::scrollguard {
+
+  /**
+   * An enum which can be represented as a JavaScript union (ScrollGuardDirection).
+   */
+  enum class ScrollGuardDirection {
+    HORIZONTAL      SWIFT_NAME(horizontal) = 0,
+    VERTICAL      SWIFT_NAME(vertical) = 1,
+    BOTH      SWIFT_NAME(both) = 2,
+  } CLOSED_ENUM;
+
+} // namespace margelo::nitro::scrollguard
+
+namespace margelo::nitro {
+
+  // C++ ScrollGuardDirection <> JS ScrollGuardDirection (union)
+  template <>
+  struct JSIConverter<margelo::nitro::scrollguard::ScrollGuardDirection> final {
+    static inline margelo::nitro::scrollguard::ScrollGuardDirection 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("horizontal"): return margelo::nitro::scrollguard::ScrollGuardDirection::HORIZONTAL;
+        case hashString("vertical"): return margelo::nitro::scrollguard::ScrollGuardDirection::VERTICAL;
+        case hashString("both"): return margelo::nitro::scrollguard::ScrollGuardDirection::BOTH;
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert \"" + unionValue + "\" to enum ScrollGuardDirection - invalid value!");
+      }
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, margelo::nitro::scrollguard::ScrollGuardDirection arg) {
+      switch (arg) {
+        case margelo::nitro::scrollguard::ScrollGuardDirection::HORIZONTAL: return JSIConverter<std::string>::toJSI(runtime, "horizontal");
+        case margelo::nitro::scrollguard::ScrollGuardDirection::VERTICAL: return JSIConverter<std::string>::toJSI(runtime, "vertical");
+        case margelo::nitro::scrollguard::ScrollGuardDirection::BOTH: return JSIConverter<std::string>::toJSI(runtime, "both");
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert ScrollGuardDirection 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("horizontal"):
+        case hashString("vertical"):
+        case hashString("both"):
+          return true;
+        default:
+          return false;
+      }
+    }
+  };
+
+} // namespace margelo::nitro

package/nitrogen/generated/shared/c++/views/HybridScrollGuardComponent.cpp

@@ -0,0 +1,87 @@
+///
+/// HybridScrollGuardComponent.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 Marc Rousavy @ Margelo
+///
+
+#include "HybridScrollGuardComponent.hpp"
+
+#include <string>
+#include <exception>
+#include <utility>
+#include <NitroModules/NitroDefines.hpp>
+#include <NitroModules/JSIConverter.hpp>
+#include <react/renderer/core/RawValue.h>
+#include <react/renderer/core/ShadowNode.h>
+#include <react/renderer/core/ComponentDescriptor.h>
+#include <react/renderer/components/view/ViewProps.h>
+
+namespace margelo::nitro::scrollguard::views {
+
+  extern const char HybridScrollGuardComponentName[] = "ScrollGuard";
+
+  HybridScrollGuardProps::HybridScrollGuardProps(const react::PropsParserContext& context,
+                                                 const HybridScrollGuardProps& sourceProps,
+                                                 const react::RawProps& rawProps):
+    react::ViewProps(context, sourceProps, rawProps, filterObjectKeys),
+    direction([&]() -> CachedProp<std::optional<ScrollGuardDirection>> {
+      try {
+        const react::RawValue* rawValue = rawProps.at("direction", nullptr, nullptr);
+        if (rawValue == nullptr) return sourceProps.direction;
+        const auto& [runtime, value] = (std::pair<jsi::Runtime*, jsi::Value>)*rawValue;
+        return CachedProp<std::optional<ScrollGuardDirection>>::fromRawValue(*runtime, value, sourceProps.direction);
+      } catch (const std::exception& exc) {
+        throw std::runtime_error(std::string("ScrollGuard.direction: ") + exc.what());
+      }
+    }()),
+    hybridRef([&]() -> CachedProp<std::optional<std::function<void(const std::shared_ptr<HybridScrollGuardSpec>& /* ref */)>>> {
+      try {
+        const react::RawValue* rawValue = rawProps.at("hybridRef", nullptr, nullptr);
+        if (rawValue == nullptr) return sourceProps.hybridRef;
+        const auto& [runtime, value] = (std::pair<jsi::Runtime*, jsi::Value>)*rawValue;
+        return CachedProp<std::optional<std::function<void(const std::shared_ptr<HybridScrollGuardSpec>& /* ref */)>>>::fromRawValue(*runtime, value.asObject(*runtime).getProperty(*runtime, "f"), sourceProps.hybridRef);
+      } catch (const std::exception& exc) {
+        throw std::runtime_error(std::string("ScrollGuard.hybridRef: ") + exc.what());
+      }
+    }()) { }
+
+  HybridScrollGuardProps::HybridScrollGuardProps(const HybridScrollGuardProps& other):
+    react::ViewProps(),
+    direction(other.direction),
+    hybridRef(other.hybridRef) { }
+
+  bool HybridScrollGuardProps::filterObjectKeys(const std::string& propName) {
+    switch (hashString(propName)) {
+      case hashString("direction"): return true;
+      case hashString("hybridRef"): return true;
+      default: return false;
+    }
+  }
+
+  HybridScrollGuardComponentDescriptor::HybridScrollGuardComponentDescriptor(const react::ComponentDescriptorParameters& parameters)
+    : ConcreteComponentDescriptor(parameters,
+                                  react::RawPropsParser(/* enableJsiParser */ true)) {}
+
+  std::shared_ptr<const react::Props> HybridScrollGuardComponentDescriptor::cloneProps(const react::PropsParserContext& context,
+                                                                                       const std::shared_ptr<const react::Props>& props,
+                                                                                       react::RawProps rawProps) const {
+    // 1. Prepare raw props parser
+    rawProps.parse(rawPropsParser_);
+    // 2. Copy props with Nitro's cached copy constructor
+    return HybridScrollGuardShadowNode::Props(context, /* & */ rawProps, props);
+  }
+
+#ifdef ANDROID
+  void HybridScrollGuardComponentDescriptor::adopt(react::ShadowNode& shadowNode) const {
+    // This is called immediately after `ShadowNode` is created, cloned or in progress.
+    // On Android, we need to wrap props in our state, which gets routed through Java and later unwrapped in JNI/C++.
+    auto& concreteShadowNode = dynamic_cast<HybridScrollGuardShadowNode&>(shadowNode);
+    const HybridScrollGuardProps& props = concreteShadowNode.getConcreteProps();
+    HybridScrollGuardState state;
+    state.setProps(props);
+    concreteShadowNode.setStateData(std::move(state));
+  }
+#endif
+
+} // namespace margelo::nitro::scrollguard::views

package/nitrogen/generated/shared/c++/views/HybridScrollGuardComponent.hpp

@@ -0,0 +1,108 @@
+///
+/// HybridScrollGuardComponent.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2026 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#include <optional>
+#include <NitroModules/NitroDefines.hpp>
+#include <NitroModules/NitroHash.hpp>
+#include <NitroModules/CachedProp.hpp>
+#include <react/renderer/core/ConcreteComponentDescriptor.h>
+#include <react/renderer/core/PropsParserContext.h>
+#include <react/renderer/components/view/ConcreteViewShadowNode.h>
+#include <react/renderer/components/view/ViewProps.h>
+
+#include "ScrollGuardDirection.hpp"
+#include <optional>
+#include <memory>
+#include "HybridScrollGuardSpec.hpp"
+#include <functional>
+
+namespace margelo::nitro::scrollguard::views {
+
+  using namespace facebook;
+
+  /**
+   * The name of the actual native View.
+   */
+  extern const char HybridScrollGuardComponentName[];
+
+  /**
+   * Props for the "ScrollGuard" View.
+   */
+  class HybridScrollGuardProps final: public react::ViewProps {
+  public:
+    HybridScrollGuardProps() = default;
+    HybridScrollGuardProps(const HybridScrollGuardProps&);
+    HybridScrollGuardProps(const react::PropsParserContext& context,
+                           const HybridScrollGuardProps& sourceProps,
+                           const react::RawProps& rawProps);
+
+  public:
+    CachedProp<std::optional<ScrollGuardDirection>> direction;
+    CachedProp<std::optional<std::function<void(const std::shared_ptr<HybridScrollGuardSpec>& /* ref */)>>> hybridRef;
+
+  private:
+    static bool filterObjectKeys(const std::string& propName);
+  };
+
+  /**
+   * State for the "ScrollGuard" View.
+   */
+  class HybridScrollGuardState final {
+  public:
+    HybridScrollGuardState() = default;
+
+  public:
+    void setProps(const HybridScrollGuardProps& props) { _props.emplace(props); }
+    const std::optional<HybridScrollGuardProps>& getProps() const { return _props; }
+
+  public:
+#ifdef ANDROID
+  HybridScrollGuardState(const HybridScrollGuardState& /* previousState */, folly::dynamic /* data */) {}
+  folly::dynamic getDynamic() const {
+    throw std::runtime_error("HybridScrollGuardState does not support folly!");
+  }
+  react::MapBuffer getMapBuffer() const {
+    throw std::runtime_error("HybridScrollGuardState does not support MapBuffer!");
+  };
+#endif
+
+  private:
+    std::optional<HybridScrollGuardProps> _props;
+  };
+
+  /**
+   * The Shadow Node for the "ScrollGuard" View.
+   */
+  using HybridScrollGuardShadowNode = react::ConcreteViewShadowNode<HybridScrollGuardComponentName /* "HybridScrollGuard" */,
+                                                                    HybridScrollGuardProps /* custom props */,
+                                                                    react::ViewEventEmitter /* default */,
+                                                                    HybridScrollGuardState /* custom state */>;
+
+  /**
+   * The Component Descriptor for the "ScrollGuard" View.
+   */
+  class HybridScrollGuardComponentDescriptor final: public react::ConcreteComponentDescriptor<HybridScrollGuardShadowNode> {
+  public:
+    HybridScrollGuardComponentDescriptor(const react::ComponentDescriptorParameters& parameters);
+
+  public:
+    /**
+     * A faster path for cloning props - reuses the caching logic from `HybridScrollGuardProps`.
+     */
+    std::shared_ptr<const react::Props> cloneProps(const react::PropsParserContext& context,
+                                                   const std::shared_ptr<const react::Props>& props,
+                                                   react::RawProps rawProps) const override;
+#ifdef ANDROID
+    void adopt(react::ShadowNode& shadowNode) const override;
+#endif
+  };
+
+  /* The actual view for "ScrollGuard" needs to be implemented in platform-specific code. */
+
+} // namespace margelo::nitro::scrollguard::views

package/nitrogen/generated/shared/json/ScrollGuardConfig.json

@@ -0,0 +1,10 @@
+{
+  "uiViewClassName": "ScrollGuard",
+  "supportsRawText": false,
+  "bubblingEventTypes": {},
+  "directEventTypes": {},
+  "validAttributes": {
+    "direction": true,
+    "hybridRef": true
+  }
+}

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@onekeyfe/react-native-scroll-guard",
+  "version": "0.1.1",
+  "description": "A native view wrapper that prevents parent scrollable containers (PagerView/ViewPager2) from intercepting child scroll gestures",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "clean": "del-cli android/build lib",
+    "prepare": "rm -rf lib && bob build && cp -r nitrogen lib/nitrogen",
+    "nitrogen": "nitrogen",
+    "typecheck": "tsc",
+    "release": "yarn nitrogen && yarn prepare && npm whoami && npm publish --access public"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android",
+    "gesture",
+    "scroll",
+    "pager"
+  ],
+  "homepage": "https://github.com/OneKeyHQ/app-modules#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OneKeyHQ/app-modules.git"
+  },
+  "author": "@onekeyfe <huanming@onekey.so> (https://github.com/OneKeyHQ/app-modules)",
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@react-native/babel-preset": "0.83.0",
+    "del-cli": "^6.0.0",
+    "nitrogen": "0.31.10",
+    "react": "19.2.0",
+    "react-native": "0.83.0",
+    "react-native-builder-bob": "^0.40.13",
+    "react-native-nitro-modules": "0.33.2",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "0.33.2"
+  },
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "custom",
+        {
+          "script": "nitrogen",
+          "clean": "nitrogen/"
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "create-react-native-library": {
+    "type": "nitro-view",
+    "languages": "kotlin-swift"
+  }
+}

package/src/ScrollGuard.nitro.ts

@@ -0,0 +1,25 @@
+import type {
+  HybridView,
+  HybridViewMethods,
+  HybridViewProps,
+} from 'react-native-nitro-modules';
+
+export enum ScrollGuardDirection {
+  HORIZONTAL = 'horizontal',
+  VERTICAL = 'vertical',
+  BOTH = 'both',
+}
+
+export interface ScrollGuardProps extends HybridViewProps {
+  /**
+   * The scroll direction to guard.
+   * - HORIZONTAL: block parent from intercepting horizontal gestures (default)
+   * - VERTICAL: block parent from intercepting vertical gestures
+   * - BOTH: block both directions
+   */
+  direction?: ScrollGuardDirection;
+}
+
+export interface ScrollGuardMethods extends HybridViewMethods {}
+
+export type ScrollGuard = HybridView<ScrollGuardProps, ScrollGuardMethods>;

package/src/index.tsx

@@ -0,0 +1,11 @@
+import { getHostComponent } from 'react-native-nitro-modules';
+const ScrollGuardConfig = require('../nitrogen/generated/shared/json/ScrollGuardConfig.json');
+import type { ScrollGuardMethods, ScrollGuardProps } from './ScrollGuard.nitro';
+export { ScrollGuardDirection } from './ScrollGuard.nitro';
+
+export const ScrollGuardView = getHostComponent<
+  ScrollGuardProps,
+  ScrollGuardMethods
+>('ScrollGuard', () => ScrollGuardConfig);
+
+export type { ScrollGuardProps, ScrollGuardMethods };