/react-native-visionos

A framework for building native applications using React

Primary LanguageC++MIT LicenseMIT

React Native Vision OS

Learn once, write anywhere:
Build spatial apps with React.

React Native Vision OS allows you to write visionOS with full support for platform SDK. This is a full fork of the main repository with changes needed to support visionOS.

Caution

This project is still at an early stage of development and is not ready for production use.

New project creation

  1. Make sure you have a proper development environment setup
  2. Download the latest Xcode beta here.
  3. Install visionOS Simulator runtime.
  4. Install the latest version of CMake (at least v3.28.0)
  5. Initialize the project using this command:
npx @callstack/react-native-visionos@latest init YourApp
  1. Next, go to YourApp/visionos folder and run following commands to install Pods:
cd visionos
bundle install
bundle exec pod install
  1. Open YourApp/visionos/YourApp.xcworkspace using Xcode 15 Beta.
  2. Build the app by clicking the "Run" button in Xcode.

Platform guidelines

We suggest you read Human Interface Guidelines for visionOS when creating visionOS apps.

It's important not to cover the translucent background with a solid color, as it helps to ground apps and make them feel like part of the environment.

Contributing

  1. Follow the same steps as in the New project creation section.
  2. Checkout rn-tester README.md to build React Native from source.

Release process

We use a script called oot-release.js which automatically releases visionos packages and aligns versions of dependencies with React Native core.

Usage:

node ./scripts/oot-release.js --new-version "<visionos-version>" --react-native-version "<react-native-version>" --one-time-password "<otp>"

To test releases and template we use Verdaccio.