Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 3.34 KB

README.md

File metadata and controls

68 lines (46 loc) · 3.34 KB
Raw

React Native for Web

npm version Build Status PRs Welcome

"React Native for Web" makes it possible to run React Native components and APIs on the web using React DOM.

Documentation

The documentation site (source) covers installation, guides, and APIs.

Example

The examples app (source) demonstrates many available features. Fork the codesandbox to make changes and see the results.

You'll notice that there is no reference to react-dom in components. The App component that is shown below is defined using the APIs and Components of React Native, but it can also be rendered on the web using React Native for Web.

// Example component
import React from 'react';
import { AppRegistry, StyleSheet, Text, View } from 'react-native';

class App extends React.Component {
  render() {
    return (
      <View style={styles.box}>
        <Text style={styles.text}>Hello, world!</Text>
      </View>
    );
  }
}

const styles = StyleSheet.create({
  box: { padding: 10 },
  text: { fontWeight: 'bold' }
});

AppRegistry.registerComponent('App', () => App);
AppRegistry.runApplication('App', { rootTag: document.getElementById('react-root') });

Contributing

Development happens in the open on GitHub and we are grateful for contributions including bugfixes, improvements, and ideas. Read below to learn how you can take part in improving React Native for Web.

Code of conduct

This project expects all participants to adhere to Meta's OSS Code of Conduct. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing guide

Read the contributing guide to learn about the development process, how to propose bugfixes and improvements, and how to build and test your changes to React Native for Web.

Good first issues

To help you get you familiar with the contribution process, there is a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

License

React Native for Web is MIT licensed. By contributing to React Native for Web, you agree that your contributions will be licensed under its MIT license.