Creating Universal Windows Apps With React Native

Sponsored ArticleCreating Universal Windows Apps With React Native

React.js1 is a popular JavaScript library for building reusable UI components. React Native2 takes all the great features of React, from the one-way binding and virtual DOM to debugging tools3, and applies them to mobile app development on iOS and Android.

With the React Native Universal Windows platform extension, you can now make your React Native applications run on the Universal Windows families of devices, including desktop, mobile, and Xbox, as well as Windows IoT, Surface Hub, and HoloLens.

In this code story, we will walk through the process of setting up a Universal Windows project for React Native, importing core Windows-specific modules to your JavaScript components, and running the app with Visual Studio.

4

Installing React Native For Windows Link

Installing the React Native Universal Windows platform extension is easy, whether you want to add the Windows platform to your existing app, or you want to start from scratch building an app just for Windows.

Adding React Native for Windows to Existing Projects Link

React Native developers may be familiar with RNPM5, a tool initially built to simplify the process of adding native dependencies to React Native projects. RNPM has a great plugin architecture upon which the React Native for Windows command line tools were built.

To start, make sure you have RNPM installed globally.

npm install -g rnpm 

Once RNPM is installed, install the Windows plugin for RNPM and initialize your project.

npm install --save-dev rnpm-plugin-windows rnpm windows 

The windows command will do the following:

  • Install react-native-windows from NPM6,
  • Read the name of your project from package.json,
  • Use Yeoman7 to generate the Windows project files.

The RNPM plugin architecture searches your local package.json dependencies and devDependencies for modules that match rnpm-plugin-*, hence the --save-dev above.

Head to GitHub8 for more information on rnpm-plugin-windows.

Creating a React Native for Windows Project from Scratch Link

You have a few different options to create a React Native Universal Windows project from scratch. If your eventual intent is to also build apps for iOS and Android in the same code base, then the recommendation is to first use the existing tutorial9 to set up your React Native project, and then follow the steps above. E.g.,

npm install -g react-native-cli react-native init myapp 

Note: the react-native-windows NPM package is only compatible with the latest versions of react-native, from version 0.27 onwards.

Otherwise, you can easily set yourself up with npm init.

mkdir myapp cd myapp npm init npm install --save-dev rnpm-plugin-windows rnpm windows 

Note: the default behavior for choosing the version of react-native-windows is to install the latest version if the package.json does not yet have a react-native dependency. Otherwise, if a react-native dependency already exists, the plugin will attempt to install a version of react-native-windows that matches the major and minor version of react-native.

The Windows plugin for RNPM will automatically install the react-native and react peer dependencies for react-native-windows if they have not yet been installed.

React Native For Windows Project Structure Link

There are a few boilerplate files that get generated for the Universal Windows App. The important ones include:

  • index.windows.js — This is the entry point to your React application.
  • windows/myapp.sln — This is where you should start to launch your app and debug native code.
  • windows/myapp/MainPage.cs — This is where you can tweak the native bridge settings, like available modules and components.

Here’s the full output:

├── index.windows.js ├── windows ├── myapp.sln ├── myapp ├── Properties ├── AssemblyInfo.cs ├── Default.rd.xml ├── Assets ├── ... ├── App.xaml ├── App.xaml.cs ├── MainPage.cs ├── project.json ├── Package.appxmanifest ├── myapp_TemporaryKey.pfx 

We ship the core C# library for React Native as source on NPM. Having direct access to the source will help with debugging and making small tweaks where necessary. As long as the core ships as source, third party modules will also need to follow suit (although their dependencies may be binary). We’ll be working with the React Native community on react-native link support to make dependency management as simple as possible. Instructions for how to link dependencies are available on GitHub10.

Building And Extending Apps For The Windows Platform Link

The core components and modules for React Native are imported as follows:

import{View,Text,Image}from'react-native';

Currently, the same goes for Android- and iOS-specific modules, i.e.:

import{TabBarIOS,DrawerLayoutAndroid}from'react-native';

Since Windows is a plugin to the framework, core modules specific to Windows are imported from react-native-windows, i.e.:

import{FlipViewWindows,SplitViewWindows}from'react-native-windows';

So, a typical imports section of a React component with a mixture of core and Windows-specific modules will look like:

importReact,{Component}from'react';import{AppRegistry,StyleSheet,Text,View}from'react-native';import{SplitViewWindows}from'react-native-windows';

There is a list of the core modules available on React Native for Windows on GitHub11.

There are multiple ways to add conditional behavior to your apps based on the platform. One way that you might already recognize is the use of the *.platform.js pattern, i.e., index.[android|ios|windows].js. The node-haste12 dependency graph will choose the filename that matches the active platform choice, and fallback to the filename without any platform indicator, if available. E.g., if you have files MyComponent.windows.js and MyComponent.js, node-haste will choose MyComponent.js for Android and iOS and MyComponent.windows.js for Windows.

Another way is to use conditional logic inside a component, as demonstrated in the simple component below.

importReact,{Component}from'react';import{Platform,Text,View}from'react-native';classHelloComponentextendsComponent{render(){vartext="Hello world!";if(Platform.OS==='android'){text="Hello Android!";}elseif(Platform.OS==='windows'){text="Hello Windows!";}return(<View><Text>{text}</text> </View> );}}

Facebook has a very good article on cross-platform design with React Native at makeitopen.com13.

Running The Universal Windows App Link

There are a few options for running your React Native Universal Windows app. The easiest way, for now, is to launch the app in Visual Studio. After initializing the project, open the Visual Studio solution at ./windows/myapp.sln in Visual Studio 201514 (Community edition is supported). From Visual Studio, choose which platform you want to build for (x86, x64, or ARM), choose the target you want to deploy to, and press F5. We are still working on deployment from the command line, but work to enable a run-windows command to the RNPM plugin is underway.

The instructions for running React Native UWP apps, both from Visual Studio and from the CLI, will be evolving on GitHub15. If you have any problems getting started with building or running your React Windows application, reach out on Discord16 or open an issue17. We look forward to hearing your feedback and reviewing your contributions18!

More Hands-On With Web And Mobile Apps Link

Check out these helpful resources on building web and Mobile Apps:

For further updates on the topic and new features, please view the original documentation25.

Footnotes Link

  1. 1 https://facebook.github.io/react/
  2. 2 https://www.smashingmagazine.com/2016/04/consider-react-native-mobile-app/
  3. 3 http://facebook.github.io/react-native/docs/debugging.html
  4. 4 https://www.smashingmagazine.com/wp-content/uploads/2016/09/Creating-Universal-Windows-Apps-with-React-Native-opt.png
  5. 5 http://github.com/RNPM/RNPM
  6. 6 https://www.npmjs.com/package/react-native-windows
  7. 7 http://yeoman.io/
  8. 8 http://github.com/ReactWindows/react-native-windows/tree/master/local-cli/rnpm
  9. 9 https://facebook.github.io/react-native/docs/tutorial.html
  10. 10 https://github.com/ReactWindows/react-native-windows/blob/master/docs/LinkingLibrariesWindows.md
  11. 11 http://github.com/ReactWindows/react-native-windows/tree/master/docs/CoreParityStatus.md
  12. 12 https://github.com/facebook/node-haste
  13. 13 http://makeitopen.com/tutorials/building-the-f8-app/design/
  14. 14 https://www.visualstudio.com/downloads/download-visual-studio-vs
  15. 15 https://github.com/ReactWindows/react-native-windows/blob/master/docs/RunningOnDeviceWindows.md
  16. 16 https://discord.gg/0ZcbPKXt5bWJVmUY
  17. 17 https://github.com/ReactWindows/react-native-windows#opening-issues
  18. 18 https://github.com/ReactWindows/react-native-windows#contributing
  19. 19 https://msdn.microsoft.com/en-us/windows/uwp/get-started/universal-application-platform-guide?wt.mc_id=873567&UWApsWReactAppsatSM
  20. 20 https://developer.microsoft.com/en-us/windows/bridges?wt.mc_id=873567&UWApsWReactAppsatSM
  21. 21 https://mva.microsoft.com/training-topics/app-development?wt.mc_id=873567&UWApsWReactAppsatSM#!lang=1049
  22. 22 https://mva.microsoft.com/training-topics/c-app-development?wt.mc_id=873567&UWApsWReactAppsatSM#!lang=1049
  23. 23 https://azure.microsoft.com/en-us/services/app-service/?wt.mc_id=873566&HybridAppsAppsatSM
  24. 24 https://www.visualstudio.com/en-us/features/xamarin-vs.aspx?wt.mc_id=873567&UWApsWReactAppsatSM
  25. 25 https://www.microsoft.com/developerblog/real-life-code/2016/05/27/Creating-Universal-Windows-Apps-with-React-Native.html?wt.mc_id=873567&UWApsWReactAppsatSM

↑ Back to topTweet itShare on Facebook

Advertisement

Eric Rozell is a Senior Software Engineer on the Developer Experience team at Microsoft. He currently leads the effort to bring React Native to the Universal Windows Platform and is a contributor to Rx.NET and RxJS.

  1. 1

    @xaviercolomer

    October 4, 2016 10:42 am

    Maybe could be interesting to use React + Electron for Universal Desktop applications as well. http://electron.atom.io/

↑ Back to top

Clicky

(Visited 41 times, 1 visits today)