babel-plugin-react-native-web

What is babel-plugin-react-native-web?

babel-plugin-react-native-web is a Babel plugin that allows you to use React Native components and APIs in a web environment. It transforms React Native imports to their web equivalents provided by the react-native-web library, enabling code sharing between React Native and web projects.

What are babel-plugin-react-native-web's main functionalities?

Transform React Native imports

This feature allows you to transform React Native imports to their web equivalents. By adding 'react-native-web' to your Babel plugins, you can use React Native components in a web environment seamlessly.

module.exports = {
  plugins: [
    'react-native-web'
  ]
};

Support for React Native APIs

This feature allows you to use React Native APIs like AppRegistry in a web environment. The code sample demonstrates how to register and run a React Native application on the web using AppRegistry.

import { AppRegistry } from 'react-native';
import App from './App';

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

StyleSheet transformation

This feature allows you to use React Native's StyleSheet for styling components in a web environment. The code sample demonstrates how to create and apply styles using StyleSheet in a React Native Web application.

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

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#F5FCFF',
  },
  welcome: {
    fontSize: 20,
    textAlign: 'center',
    margin: 10,
  }
});

const App = () => (
  <View style={styles.container}>
    <Text style={styles.welcome}>Welcome to React Native Web!</Text>
  </View>
);

Other packages similar to babel-plugin-react-native-web

react-native-web

react-native-web is a library that provides React Native components and APIs for the web. It allows you to write a single codebase that runs on both React Native and web platforms. Unlike babel-plugin-react-native-web, which is a Babel plugin, react-native-web is a library that you import and use directly in your project.

react-native-dom

react-native-dom is an experimental project that aims to bring React Native to the web by providing a DOM renderer for React Native. It allows you to run React Native applications in a web environment. While it shares a similar goal with babel-plugin-react-native-web, it is still in an experimental stage and not as widely adopted.

react-primitives

react-primitives is a library that provides a set of primitive components that work across multiple platforms, including web, iOS, and Android. It allows you to write platform-agnostic components that can be used in both React Native and web projects. Unlike babel-plugin-react-native-web, which focuses on transforming React Native imports, react-primitives provides a unified set of components for cross-platform development.

README

babel-plugin-react-native-web

A Babel plugin that will alias react-native to react-native-web and exclude any modules not required by your app (keeping bundle size down).

Installation

yarn add --dev babel-plugin-react-native-web

Usage

.babelrc

{
  "plugins": [
    ["react-native-web", { commonjs: true }]
  ]
}

You should configure the plugin to match the module format used by your bundler. Most modern bundlers will use a package's ES modules by default (i.e., if package.json has a module field). But if you need the plugin to rewrite import paths to point to CommonJS modules, you must set the commonjs option to true.

Example

NOTE: react-native-web internal paths are not stable and you must not rely on them. Always use the Babel plugin to optimize your build. What follows is an example of the rewrite performed by the plugin.

Before

import { StyleSheet, View } from 'react-native';

After

import StyleSheet from 'react-native-web/dist/exports/StyleSheet';
import View from 'react-native-web/dist/exports/View';