Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ammarahm-ed/react-native-jsi-template
Template library and blog that explain how JSI modules are built from scratch in React Native
https://github.com/ammarahm-ed/react-native-jsi-template
android ios jsi-modules native-modules react-native reactnative
Last synced: 13 days ago
JSON representation
Template library and blog that explain how JSI modules are built from scratch in React Native
- Host: GitHub
- URL: https://github.com/ammarahm-ed/react-native-jsi-template
- Owner: ammarahm-ed
- License: mit
- Created: 2021-06-23T14:34:43.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-29T19:57:17.000Z (over 2 years ago)
- Last Synced: 2024-10-23T03:30:34.202Z (21 days ago)
- Topics: android, ios, jsi-modules, native-modules, react-native, reactnative
- Language: C++
- Homepage: https://blog.notesnook.com/getting-started-react-native-jsi/
- Size: 452 KB
- Stars: 162
- Watchers: 4
- Forks: 24
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-jsi-template
This is an example library that explains how anyone can build jsi modules from scratch in React Native. This code is written as a support project for my [blog](https://blog.notesnook.com/getting-started-react-native-jsi/).
## Installation
```sh
npm install react-native-simple-jsi
```
For iOS also run `pod install` in `/ios` folder.
## Prerequisites
You must have Android NDK and CMake installed on android to build the library.
## Methods
The following methods are implemented.
### Platfom agnostic
The relevant code is present in `cpp/example.cpp` file.
```ts
helloWorld():string;
multiplyWithCallback(x:number,y:number,callback:(z:number) => void):void
multiply(x:number,y:number):number
```
### Platform specific
The relevant code on android is in `android/cpp-adapter.cpp` and `ios/SimpleJsi.mm` on iOS.
```ts
getDeviceName():string
setItem(key:string,value:string):boolean
getItem(key:string):string
```
## Basic usage example
```tsx
import simpleJsiModule from "react-native-jsi-template";
simpleJsiModule.helloWorld() // returns helloworld.
```
Run the example app for more.
## Thanks to these libraries & their authors:
The initial work done by authors of the following libraries has helped a lot in writing the blog and keeping this repo updated.
- [react-native-mmkv](https://github.com/mrousavy/react-native-mmkv/)
- [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated/)
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT