create-react-native-plugin

create-react-native-plugin

Starting point for creating React Native plugins in TypeScript without native code.

• Bundle plugin in TypeScript with esbuild
• Setup demo app with plugin installed
• Watch plugin for changes
• Jest, ESLint and Prettier configured

Usage

:warning: node: Requires at least node version 16.

npm init -y react-native-plugin@latest react-native-my-plugin
# or
npx create-react-native-plugin@latest react-native-my-plugin

This will bootstrap a new plugin inside a folder named react-native-my-plugin accordingly. Inside that folder the commands mentioned hereafter are available. The prefix react-native- is optional and will be removed where the React Native context is implied.

Start working on your plugin by editing index.tsx which will be the entry point for the plugin.

App

Since you probably don't want to blind-code the whole plugin use the following command to generate an up-to-date React Native app which includes the plugin:

npm run app

This will create an app inside /app where except /app/App.tsx all files are gitignored. Here you can try out various use cases of the plugin and use this as a way to demonstrate the plugin. The app can be started as usual by running npm run ios or npm run android inside the /app folder.

npm run watch

Running the above in the root folder will watch the plugin source code for any kind of changes, rebuild and copy over the changes to the app which will then automatically hot-reload.

Don't forget to always check your plugin both on Android and iOS even though your not using native code the provided components might still differ depending on the platform.

Tests

The template is configured to work with Jest out of the box. All non-native functionality can be tested from the terminal. With the following command you can run the tests which are found in a folder with the same name:

npm test
npm run test:watch # Keep watching and retesting on changes.

Troubleshooting

If you have issues building the app for iOS try the following

• Update XCode in the App Store (installation takes time)
• Update Cocoapods with sudo gem install cocoapods
• Update Pod dependencies in app/ios folder with pod update

To avoid bundling additional dependencies with esbuild mark them as --external in the npm run build script.

Examples

The following plugins have been created with create-react-native-plugin as a starting point.

• Reactigation JS-only navigation for React Native.
• React Native Cols Grid for React Native.
• React Native Indicate Scroll indicator for views with overflow.
• Naxos UI Library.
• Responsive React Native Automatically transforms StyleSheet values responsively.