React Native plugin for Universal Windows Platform (UWP)
This repository adds support for the Windows 10 SDK, which allows you to build apps for:
- Windows 10
- Windows 10 Mobile
- Xbox One (UWP)
- Getting Started
- Getting Help
- Extending React Native
- Opening Issues
- Code of Conduct
See the official React Native website for an introduction to React Native.
- Follow the Getting Started guide to install React Native and its dependencies.
- Change your working directory to the project directory you specified in the
react-native initcommand from the Getting Started guide (e.g.,
- Install rnpm-plugin-windows from NPM (i.e.,
npm install --save-dev rnpm-plugin-windows).
- Initialize Windows project with
react-native windowscommand in the project directory.
- Learn more about various tools for debugging React Native.
- For more information about how to deploy to Windows simulators/devices, and how to create a bundle for Release, view RunningOnDeviceWindows
In addition to the requirements from the Getting Started guide:
If this is your first time using UWP, you may be able to install the SDK by opening the solution file in the ReactWindows folder in Visual Studio. After opening the solution, right click the Solution in the Solution Explorer and select the option labeled "Install Missing Components". You may have to shutdown Visual Studio to continue the installation.
If you happen to run into issues while setting up React Native Windows on your machine, check out the Setup Troubleshooting documentation.
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
- Chat with us on Reactiflux in #react-native-platforms
- If it turns out that you may have found a bug, please open an issue
React Native already has great documentation, and we're working to ensure the React Native Windows plugin is part of that documentation story. Check out the React documentation for further details about the React API in general.
For information on parity status with Android and iOS, including details on implemented and missing components and modules, along with related issues for missing features from partial implementations, go here.
git clone --recursive https://github.com/ReactWindows/react-native-windows.git cd react-native-windows npm install
Running the examples
- Start the React Native packager by running
- Open Examples.sln from the Examples submodule folder in Visual Studio.
- Set the StartUp project to the example you want to run, press F5.
Showing the Debug Menu
- On UWP, press Shift+F10 to open the debug menu.
- On WPF, press CTRL+D or CTRL+M to open the debug menu.
Extending React Native
- Looking for a component? JS.coach
- Fellow developers write and publish React Native modules to npm and open source them on GitHub.
- Many third party modules may be missing Windows support, so reach out to the project owners directly.
- Making modules helps grow the React Native ecosystem and community. We recommend writing modules for your use cases and sharing them on npm.
- Read the guides on Native Modules for Windows and Native UI Components for Windows if you are interested in extending native functionality.
If you encounter a bug with the React Native Windows plugin, we would like to hear about it. Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of React Native, React Native Windows plugin, and device family (i.e., mobile, desktop, Xbox, etc.) you’re using. Please include a stack trace and reduced repro case when appropriate, too.
The GitHub issues are intended for bug reports and feature requests. For help and questions with using the React Native Windows plugin please make use of the resources listed in the Getting Help section. There are limited resources available for handling issues and by keeping the list of open issues lean we can respond in a timely manner.
For more information about contributing PRs and issues, see our Contribution Guidelines (Coming Soon).
We're still working on our CI story. In the meantime, please be sure to run the unit tests in Visual Studio before submitting pull requests.
The React Native Windows plugin is provided under the MIT License.