React Native: Changing the Default iOS Simulator Device

React Native, a popular framework for building mobile applications using JavaScript and React, provides the flexibility to run your apps not only on physical devices but also on simulators. By default, when you run react-native run-ios, the application launches on a predefined iOS simulator, typically the latest version available. However, you might need to test your application on a different simulator device. In this article, we'll explore how to change the default iOS simulator device in a React Native project.

Understanding iOS Simulator Setup

When you launch an iOS simulator for a React Native application, the framework interacts with Xcode's simulator tool, simctl. The simctl command-line utility enables listing, creating, managing, and booting simulator devices.

Listing Available Simulators

Before changing the default simulator, it's beneficial to know which simulators are available. You can list all the available simulators using:

xcrun simctl list devices

This command will output a list of all simulators, including device names, their states (e.g., Booted, Shutdown), and unique identifiers (UDIDs).

Example output:

1== Devices ==
2-- iOS 14.5 --
3    iPhone 8 (E573D232-91A6-45EC-8C34-D1B753DFD63E) (Booted)​
4    iPhone 12 (6EAC2BC5-DC2D-4FA1-8B05-923B6F150FE4) (Shutdown)

Setting a Default Device

React Native provides a straightforward way to set a different simulator as the default by altering the run command's behavior. Here’s how to specify a particular simulator device:

react-native run-ios --simulator="iPhone 8"

Replace "iPhone 8" with the name of the simulator device you want to use.

Using the Simulator UDID

While specifying the simulator name is often enough, there may be cases where simulator names are ambiguous or duplicated across different iOS versions. In such scenarios, using the device’s UDID is more precise.

To run the app on a simulator with a specific UDID, use:

react-native run-ios --udid E573D232-91A6-45EC-8C34-D1B753DFD63E

This command directly targets the simulator associated with the provided UDID.

Automating Defaults

For convenience, you might want to avoid specifying the desired simulator repeatedly. You can automate this process by scripting or setting environment variables.

Automated Script

Create a script, say run-simulator.sh, with the preferred device:

1#!/bin/bash
2
3SIMULATOR_NAME="iPhone 8"
4react-native run-ios --simulator="$SIMULATOR_NAME"

Make the script executable:

chmod +x run-simulator.sh

Now, you can start your preferred simulator with ./run-simulator.sh.

Environment Variables

You can also leverage environment variables to manage defaults within a .env file or directly in scripts:

export REACT_NATIVE_SIMULATOR="iPhone 8"
react-native run-ios --simulator="$REACT_NATIVE_SIMULATOR"

Summary Table

Conclusion

React Native's ability to configure which iOS simulator to use is essential for testing on varying device profiles. By understanding and utilizing commands like simctl, along with automation techniques, you can streamline your development workflow, ensuring your React Native applications are tested across the necessary environments efficiently.