Skip to content
A framework for building native Windows apps with React.
Branch: master
Clone or download

README.md

React Native for Windows

Build native Windows apps with React.

React Native for Windows is released under the MIT license. Current Appveyor build status. Current npm package version. PRs welcome!

Hero Image with Logo

React Native enables you to build world-class application experiences on native platforms using a consistent developer experience based on JavaScript and React. The focus of React Native is on developer efficiency across all the platforms you care about - learn once, write anywhere. Facebook uses React Native in multiple production apps and will continue investing in React Native.

This repository adds support for the Windows 10 SDK, which allows you to build apps for all devices supported by Windows 10 including PCs, tablets, 2-in-1s, Xbox, Mixed reality devices etc.

Status

We are in the process of re-implementing react-native-windows in C++, for better performance, and to better align with the shared C++ react-native core as it evolves. This effort is currently taking place in the vnext subdirectory within this GitHub repo. You can read more about this effort here. We are tracking progress on this work through Projects and Issues on this GitHub repo.

The "current" subdirectory holds the earlier C# implementation for react-native-windows.

Our intent is to provide a compatibility layer that will support existing apps, view managers, and native modules written in C# with minimal breaking changes.

We anticipate that there will be increased activity on the repository related to this refactoring effort, but that overall effort allocated to the existing architecture will be minimized. Please continue to report issues as you encounter them, but be sure to use the correct template for issues related to the existing react-native-windows package (version 0.57 and earlier).

Quick Links

Introduction

See the official React Native website for an introduction to React Native.

System Requirements

  • You can run React Native Windows UWP apps only on Windows 10 devices
    • React Native Windows -current supports Windows 10 SDK > 14393 and Windows 8.1
    • React Native Windows -vnext currently supports Windows 10 SDK > 16299
  • You can run React Native Windows WPF apps using the current implementation on Windows 7-10 so long as .NET 4.6 is installed on the end user's machine
  • Download Visual Studio 2017 Community or Greater. (Visual Studio 2015 support has been deprecated.)
    • You will need to start Visual Studio after it is installed to do some final setup before it can be used to build or run your React Native Windows application

Note: Development on React Native Windows itself currently requires Visual Studio 2017. It is not supported with VS Code, but we will gladly accept pull requests to enable a great developer experience in those environments.

Getting Started

Want to develop a React Native Windows app? Head over to our Getting Started Guide - current.

You can also begin to prototype or try out the vnext version under development by checking out the Getting Started Guide - vnext

Getting Help

  • Chat with us on Reactiflux in #react-native-platforms
  • If it turns out that you may have found a bug, please open an issue

Documentation

React Native already has great documentation, and we're working to ensure the React Native Windows 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 for the current react-native-windows implementation. We are working on publishing a similar parity status for vnext shortly.

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.
  • 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.
  • You should almost never need to modify or fork React Native Windows itself (the ReactNative and ReactNative.Shared project/sources) to create custom controls. The extension points should already exist to do just about anything!
  • Read the guides on Native Modules for Windows and Native UI Components for Windows if you are interested in extending native functionality. Note: Guides for vnext coming soon.

Opening Issues

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 Windows, 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.

Please use either the current vs. vnext issue template as appropriate.

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.

Contributing

Make sure to install the system requirements. If you just want to get started with developing your own app, read Getting Started with App Development. You only need to interact with npm to use for your app development.

For more information about contributing PRs, see :

Good First Task and help wanted are great starting points for PRs.

Examples

  • Using the CLI in the Getting Started sections will set you up with a sample React-Native-Windows app that you can begin editing.
  • If you're looking for sample code, just browse the RNTester folder in the GitHub web UI

License

The React Native Windows plugin, including modifications to the original Facebook source code, and all newly contributed code is provided under the MIT License. Portions of the React Native Windows plugin derived from React Native are copyright Facebook.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

You can’t perform that action at this time.