@ubjs/react-native
v0.31.0-7
Published
The uniffi JSI player for React Native: one native module that loads any uniffi-bindgen-react-native library
Readme
@ubjs/react-native
The uniffi JSI player for React Native. Install it once in an app and every
library generated by uniffi-bindgen-react-native for the jsi2 flavour can
load its Rust code through it.
For app developers
npm install @ubjs/react-nativeIt must be a direct dependency of the app — React Native autolinking only
reads the app's own package.json. Then pod install (iOS) or a Gradle sync
(Android). No Rust toolchain is needed: the player's Rust half ships prebuilt in
this package as a shared library per slice, and its C++ compiles inside your app
build like any other native module. On iOS the Rust half is a framework that
CocoaPods embeds and signs with your app's identity.
For library authors
Declare "@ubjs/react-native" as a peerDependency and tell your users to add
it. Bindgen takes the library's name as ubrn generate jsi2 bindings --lib-name
<name> — one name per built cdylib, shared by all of that library's modules —
and emits bindings that call globalThis.uniffi.open({ name }) with it; the
player resolves that name to lib<name>.so in the app's native libraries on
Android and the embedded <name>.framework on iOS.
What is in the box
| path | |
|---|---|
| cpp/ | the JSI shim, compiled by the consumer against its own React Native headers |
| include/ubrn_jsi.h | the C ABI between the shim and the Rust half |
| prebuilt/ | the Rust half (uniffi-runtime-jsi: dispatch, libffi, dlopen), shared, per slice |
| ios/, android/ | one TurboModule per platform that hands the shim the JS runtime and CallInvoker |
Android ships arm64-v8a and x86_64. iOS ships device arm64 and the
arm64/x86_64 simulators as one dynamic xcframework.
