Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 6.04 KB

README.md

File metadata and controls

74 lines (53 loc) · 6.04 KB

React Native for Windows

Build native Windows apps with React.

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

Hero Image with Logo

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

React Native is a framework developed by Meta that 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.

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.

Visit the official React Native for Windows + macOS website to learn more.

Contents

Status and roadmap

Check out our blog if you'd like to stay up to date on the status of React Native for Windows and check out current and past roadmaps.

New Architecture

Fabric is the new rendering system for React Native, designed to share more rendering logic cross-platform. RNW's existing Paper renderer is built on UWP XAML, dropping down into native Composition as need be; the new RNW Fabric renderer targets Composition from the start but has the ability to host islands of XAML for advanced native controls. Apps on the new architecture will be WinAppSDK Win32 by default. For detailed on our roadmap to Fabric, check out this pinned issue.

Getting Started

See the Getting Started Guide on our React Native for Windows + macOS website to build your first React Native for Windows app.

Requirements

You can run React Native Windows apps only on devices supported by the Windows 10 SDK.

For a full and detailed list of the system requirements and how to set up your development platform, see our System Requirements documentation on our website.

Logging Issues

Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. If your issue doesn't exist yet, provide as much information as possible so we can better help you. Include the information requested by the appropriate issue template.

Documentation

React Native has great documentation. React Native for Windows adds its own separate Windows and macOS documentation for desktop platform information like API docs and blog updates.

Examples

  • Using the CLI in the Getting Started guide will set you up with a sample React Native for Windows app that you can begin editing right away.
  • Check the samples repo for more standalone samples.
  • The React Native Gallery app demonstrates various components in an interactive way.
  • Check out the React Native Developer Blog to see examples from past conference talks, blog posts, and more.
  • For more sample code browse the RNTester folder in the GitHub web UI.

Contributing

See Contributing guidelines for how to setup your fork of the repo and start a PR to contribute to React Native for Windows.

Not sure where to start? The good first issue and help wanted labels are the best starting points.

License

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

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 [email protected] with any additional questions or comments.