Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brodycj/create-react-native-module
https://github.com/brodycj/create-react-native-module
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/brodycj/create-react-native-module
- Owner: brodycj
- License: mit
- Created: 2019-02-25T17:02:27.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-11T10:12:56.000Z (about 1 month ago)
- Last Synced: 2025-01-05T11:02:23.499Z (15 days ago)
- Language: JavaScript
- Size: 3.71 MB
- Stars: 666
- Watchers: 6
- Forks: 52
- Open Issues: 121
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# create-react-native-module
Tool to create a React Native library module or native view component, with a single command.
[](./LICENSE)
[](https://www.npmjs.com/package/create-react-native-module)
[](https://dashboard.stryker-mutator.io/reports/github.com/brodybits/create-react-native-module/master)
[](https://npmcharts.com/compare/create-react-native-module?minimal=true)
[](https://npmcharts.com/compare/create-react-native-module?minimal=true)
[](https://github.com/brodybits/create-react-native-module/watchers)
[](https://github.com/brodybits/create-react-native-module/stargazers)
[](https://github.com/brodybits/create-react-native-module/network/members)
[](https://github.com/brodybits/create-react-native-module/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Abug)
[](https://github.com/brodybits/create-react-native-module/issues)
[](https://github.com/brodybits/create-react-native-module/pulls)
See below for command-line usage, example with no view, and example with an extremely simple native view.
This tool based on [`react-native-create-library`](https://www.npmjs.com/package/react-native-create-library), with working example callbacks, optional native view, and more updates added by [@brodybits (Christoper J. Brody aka Chris Brody)](https://github.com/brodybits) and other [contributors](https://github.com/brodybits/create-react-native-module/graphs/contributors).
### Support options
- community support via [issues](https://github.com/brodybits/create-react-native-module/issues)
- commercial support is available, please contact if interested:
### General status
- Minimum React Native version: `0.60` (outdated), `0.64` or upcoming `0.65` (recommended) - see issue [`#423`](https://github.com/brodybits/create-react-native-module/issues/423)
- It is recommended to disable or remove Flipper on iOS in case of debug build issues - see issue [`#422`](https://github.com/brodybits/create-react-native-module/issues/422)
- generated example app with symlink by default, has known issue with adding dependencies to the library root - see issue [`#308`](https://github.com/brodybits/create-react-native-module/issues/308)
- Platform fork support
- tvOS platform fork
- requires use of `--tvos-enabled` option as documented below
- requires the [`react-native-tvos`](https://www.npmjs.com/package/react-native-tvos) fork, with minimum version of `0.60.x` (newer version is *highly recommended*) ref:
- [`react-native-tvos/react-native-tvos#11`](https://github.com/react-native-tvos/react-native-tvos/issues/11)
- issue [`#95`](https://github.com/brodybits/create-react-native-module/issues/95)
- It is recommended to disable or remove Flipper in case of debug build issues - see issue [`#422`](https://github.com/brodybits/create-react-native-module/issues/422)
- Out-of-tree target platforms
- Windows target platform - not supported directly, please use `react-native-windows-init` according to this procedure: https://aka.ms/RNW-NativeModuleSetup
- for future consideration: macOS (see issue [`#94`](https://github.com/brodybits/create-react-native-module/issues/94))
### Why might you need this?
If you are looking to create a native module for React Native, you need some native code for each platform you want to support and then some JavaScript code to bind it all together. Setting this up by yourself can be time-consuming.
This is where this tool comes in. It creates a boilerplate with all current best practices in mind.
Why not use `react-native new-library`? Unfortunately that command doesn't create an up-to-date library, requires an already initialized React Native project and only sets up the iOS side of things.
### Alternatives
- [`otobank/create-react-native-module`](https://github.com/otobank/create-react-native-module) - fork with TypeScript, Swift, and Kotlin support, with some other updates and some less useful features removed; see also issue [`#425`](https://github.com/brodybits/create-react-native-module/issues/425)
- [`brodybits/react-native-module-init`](https://github.com/brodybits/react-native-module-init) - new interactive CLI that uses the templates from this utiity
- [`react-native-community/bob`](https://github.com/react-native-community/bob) - opinionated, interactive library CLI that is designed to support both native libraries and libraries with web support
__Outdated alternatives:__ see [acknowledgements](#acknowledgements) below
## Installation
Package required to be installed globally if the recommended example app is generated:
- [`yarn`](https://www.npmjs.com/package/yarn)
```console
$ npm install -g yarn
```
To install this package:
```console
$ npm install -g create-react-native-module
```
## Command-line usage
Navigate into an empty directory to execute the command.
```console
$ create-react-native-module MyFancyLibrary
```
This will create the folder `MyFancyLibrary` in which the library will be created in.
Now install dependencies by running this command in the newly created library.
```console
$ npm install
```
```console
Usage: create-react-native-module [options]
Options:
-V, --version output the version number
--package-name The full package name to be used in package.json. Default: react-native-(name in param-case)
--is-view Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.
--object-class-name The name of the object class to be exported by both JavaScript and native code. Default: (name in PascalCase)
--native-package-id [Android] The native Java package identifier used for Android (Default: `com.reactlibrary`)
--platforms Platforms the library module will be created for - comma separated (Default: `ios,android`)
--tvos-enabled Generate the module with tvOS build enabled (requires react-native-tvos fork, with minimum version of 0.60, and iOS platform to be enabled)
--github-account The github account where the library module is hosted (Default: `github_account`)
--author-name The author's name (Default: `Your Name`)
--author-email The author's email (Default: `[email protected]`)
--license The license type (Default: `MIT`)
--use-apple-networking [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code - see issue #426
--generate-example Generate an example project and add the library module to it with symlink by defult, with overwrite of example metro.config.js to add workaround for Metro symlink issue - requires Yarn to be installed globally
--example-file-linkage DEPRECATED: do `yarn add file:../` instead of `yarn add link:../` in a generated example project, and add a postinstall workaround script, with no overwrite of example metro.config.js
--example-name Name for the example project (default: `example`)
--example-react-native-template <...> The React Native template used for the generated example project, for example: react-native-tvos or [email protected] (requires --tvos-enabled option); [email protected] (default: `react-native@latest`)
--write-example-podfile [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile
-h, --help output usage information
```
## Programmatic usage
```javascript
const createLibraryModule = require('create-react-native-module');
createLibraryModule({
name: 'MyFancyLibraryModule'
}).then(() => {
console.log('Oh yay! My library module has been created!');
})
```
#### Options
```javascript
{
name: String, /* The name of the library (mandatory) */
packageName: String, /* The full package name to be used in package.json. Default: react-native-(name in param-case) */
isView: Boolean, /* Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing. (Default: false) */
objectClassName: String, /* The name of the object class to be exported by both JavaScript and native code. Default: (name in PascalCase) */
platforms: Array | String, /* Platforms the library will be created for. (Default: ['android', 'ios']) */
nativePackageId: String, /* [Android] The native Java package identifier used for Android (Default: `com.reactlibrary`) */
tvosEnabled: Boolean, /* Generate the module with tvOS build enabled (requires react-native-tvos fork, with minimum version of 0.60, and iOS platform to be enabled) */
githubAccount: String, /* The github account where the library is hosted (Default: `github_account`) */
authorName: String, /* The author's name (Default: `Your Name`) */
authorEmail: String, /* The author's email (Default: `[email protected]`) */
license: String, /* The license type of this library (Default: `MIT`) */
useAppleNetworking: Boolean, /* [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code - see issue #426 (Default: false) */
generateExample: Boolean, /* Generate an example project and add the library module to it with symlink by defult, with overwrite of example metro.config.js to add workaround for Metro symlink issue - requires Yarn to be installed globally (Default: false) */
exampleFileLinkage: Boolean, /* DEPRECATED: do `yarn add file:../` instead of `yarn add link:../` in a generated example project, and add a postinstall workaround script, with no overwrite of example metro.config.js (Default: false) */
exampleName: String, /* Name for the example project (Default: `example`) */
exampleReactNativeTemplate: String, /* The React Native template used for the generated example project, for example: react-native-tvos or [email protected] (requires --tvos-enabled option); [email protected] (Default: `react-native@latest`) */
writeExamplePodfile: Boolean, /* [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile (Default: false) */
}
```
## Examples
### Example module with no view
__Create the module with no view:__
```console
create-react-native-module --package-identifier io.mylibrary --generate-example AliceHelper
```
The module would be generated in the `react-native-alice-helper` subdirectory, and the example test app would be in `react-native-alice-helper/example`.
Then go into the example app subdirectory:
```console
cd react-native-alice-helper/example
```
#### Running the example app
**Recommended:** Follow the instructions shown in the end of the console log output, which are more likely to be up-to-date.
__Extra notes:__
_Within the example test app subdirectory:_
It is *recommended* to start the Metro Bundler manually (within `react-native-alice-helper/example`), which would run in the foreground:
```console
yarn start
```
Otherwise, React Native will open its own window to run the Metro Bundler.
To run on Android, do the following command (within `react-native-alice-helper/example`):
```console
yarn android
```
for React Native `0.60`: `npx react-native run-android`
This assumes that the `ANDROID_HOME` environmental variable is set properly. Here is a sample command that does not make such an assumption on a mac:
```console
ANDROID_HOME=~/Library/Android/sdk npx react-native run-android
```
For iOS:
Extra installation step needed _in case of clean checkout only_:
```console
cd ios && pod install && cd ..
```
Then to run on iOS:
```console
yarn ios
```
for React Native `0.60`: `npx react-native run-ios`
or do the following command to open the iOS project in Xcode:
```console
open ios/example.xcodeproj
```
#### Expected result
The example app shows the following indications:
- STATUS: native callback received
- NATIVE CALLBACK MESSAGE with the number argument and string argument values that are received by the native module
### Example view module
EXPERIMENTAL feature with limited testing
__Create the module with an extremely simple view:__
```console
create-react-native-module --package-identifier io.mylibrary --is-view --generate-example CarolWidget
```
The module would be generated in the `react-native-carol-widget` subdirectory, and the example test app would be in `react-native-carol-widget/example`.
Then go into the example app subdirectory:
```console
cd react-native-carol-widget/example
```
#### Running the view example app
**Recommended:** Follow the instructions shown in the end of the console log output, which are more likely to be up-to-date.
__Some extra notes:__
_Within the example test app subdirectory:_
It is *recommended* to start the Metro Bundler manually as described above (within `react-native-carol-widget/example`):
```console
yarn start
```
To run on Android: do `yarn android` or `npx react-native run-android` as described for the other example above.
To run on iOS (as described above):
- _in case of clean checkout **only**_: do `pod install` in `ios` subdirectory
- do `yarn ios`, `npx react-native run-ios`, or `open ios/example.xcodeproj`
__Expected result:__
- on Android: a check box that is checked (and cannot be changed)
- on iOS: a label with 5 red asterisks
## Acknowledgements
- [`react-native-create-library`](https://www.npmjs.com/package/react-native-create-library) - original basis of this project
- [`react-native-share`](https://www.npmjs.com/package/react-native-share) - was acknowledged as "a great source of inspiration" for [`react-native-create-library`](https://www.npmjs.com/package/react-native-create-library)
## License
[MIT](./LICENSE)