How do I install react-native-arkit in my React Native project?

Follow the manual installation steps in the README: add RCTARKit.xcodeproj and PocketSVG.xcodeproj to your Xcode project, link the libraries, and configure build settings for arm64. Automatic installation is currently broken due to missing PocketSVG.

Does react-native-arkit work on Android or is it iOS only?

It is iOS-only, binding specifically to Apple's ARKit. For Android support, the README suggests using ViroCommunity/viro, which offers cross-platform AR capabilities with ARCore.

What 3D model formats does react-native-arkit support?

It supports .scn and .dae formats for 3D models, as mentioned in the Model component documentation. You need to place the model files in the iOS project's assets, like art.scnassets.

How to detect and interact with planes in AR using react-native-arkit?

Use the planeDetection prop on the ARKit component and event listeners like onPlaneDetected. Then, use hit testing methods or the withProjectedPosition higher-order component to position objects relative to detected planes.

react-native-arkit vs Viro: which one should I use?

react-native-arkit is tailored for iOS ARKit with a declarative API but is unmaintained. Viro supports both iOS and Android, is actively maintained, and has a broader feature set, making it a more future-proof choice for cross-platform projects.

Is react-native-arkit still maintained in 2024?

No, the README indicates it is not maintained and is looking for maintainers. It recommends alternatives like ViroCommunity/viro, so it's not suitable for new projects requiring updates or support.

Open-Awesome

react-native-arkit

MITObjective-C0.9.0

React Native binding for iOS ARKit, enabling augmented reality app development with 3D components and plane detection.

GitHub

1.7k stars140 forks0 contributors

What is react-native-arkit?

react-native-arkit is a React Native library that provides a JavaScript interface to Apple's ARKit framework for iOS. It allows developers to build augmented reality experiences using familiar React component patterns, making AR development more accessible within the React Native ecosystem. The library offers features like plane detection, 3D primitive rendering, hit testing, and model loading through a declarative API.

Target Audience

React Native developers building iOS-only augmented reality applications who want to leverage ARKit's capabilities without writing native iOS code. It's suited for those creating AR experiences like interior design assistants, interactive product visualizations, or educational tools on compatible Apple devices.

Value Proposition

Developers choose react-native-arkit because it brings ARKit's powerful features to React Native with a component-based, declarative API that mirrors React's design principles, allowing complex AR scenes to be composed from reusable pieces. It simplifies AR development by abstracting native ARKit complexities into JavaScript, though it's iOS-only and currently unmaintained, with alternatives like ViroCommunity/viro recommended for cross-platform support.

Overview

React Native binding for iOS ARKit

Use Cases

Best For

Building iOS-only augmented reality apps with React Native using ARKit's plane detection and anchor features.
Creating AR experiences that require 3D primitive rendering like boxes, spheres, and text in a virtual space.
Developing interactive AR applications that utilize hit testing against detected planes or 3D scene objects.
Loading and displaying 3D model files in .scn or .dae formats within an AR environment on iOS.
Implementing AR features like light estimation, material customization, and shadow casting in React Native projects.
Prototyping AR applications quickly with a declarative, component-based API familiar to React developers.

Not Ideal For

Projects requiring cross-platform AR support for both iOS and Android.
Teams needing ongoing maintenance and updates for production applications.
Developers seeking a straightforward, automated installation process without native iOS configuration.

Pros & Cons

Pros

Declarative AR Composition

Enables building AR scenes using React's component-based patterns, as demonstrated in the sample code where 3D objects are composed within the ARKit component.

Comprehensive ARKit Integration

Exposes a wide range of ARKit features including plane detection, light estimation, and hit testing through a JavaScript API, making native capabilities accessible in React Native.

Rich 3D Object Support

Includes built-in primitives like boxes, spheres, and text, plus the ability to load .scn or .dae model files, reducing the need for custom 3D asset creation.

Cons

Unmaintained Project Status

The repository is openly seeking maintainers and recommends alternatives, indicating no active development, bug fixes, or support for newer iOS versions.

iOS-Exclusive Platform Lock

Only supports iOS with ARKit, excluding Android and other platforms, which limits app reach and requires separate solutions for cross-platform AR.

Complex Setup and Dependencies

Requires manual Xcode configuration, broken automatic installation, and has compatibility issues with npm and specific device hardware (A9+ processors, iOS 11+).

Frequently Asked Questions

Related Projects

React Native Firebase

🔥 A well-tested feature-rich modular Firebase implementation for React Native. Supports both iOS & Android platforms for all Firebase services.

Stars12,303

Forks2,319

Last commit1 day ago

react-native-push-notification

React Native Local and Remote Notifications

Stars6,792

Forks2,003

Last commit2 years ago

react-native-device-info

Device Information for React Native iOS and Android

Stars6,671

Forks1,459

Last commit6 days ago

react-native-fs

Native filesystem access for react-native

Stars5,043

Forks1,011