You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+88Lines changed: 88 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@ This library is a wrapper around the iOS/Android runtime, providing a component
19
19
- 🏃 [Migration Guides](#migration-guides)
20
20
- 👨💻 [Contributing](#contributing)
21
21
-:question:[Issues](#issues)
22
+
-:wrench:[Native SDK Version Customization](#native-sdk-version-customization)
22
23
23
24
## Rive Overview
24
25
@@ -77,3 +78,90 @@ We love contributions! Check out our [contributing docs](./CONTRIBUTING.md) to g
77
78
## Issues
78
79
79
80
Have an issue with using the runtime, or want to suggest a feature/API to help make your development life better? Log an issue in our [issues](https://github.com/rive-app/rive-react-native/issues) tab! You can also browse older issues and discussion threads there to see solutions that may have worked for common problems.
81
+
82
+
## Native SDK Version Customization
83
+
84
+
> **⚠️ Advanced Configuration**
85
+
> This section is for advanced users who need to use specific versions of the Rive native SDKs. In most cases, you should use the default versions that come with the library. Only customize these versions if you have a specific requirement and understand the potential compatibility implications.
86
+
>
87
+
> **Important:** If you customize the native SDK versions and later update `rive-react-native` to a newer version, you should revisit your custom version settings. The custom versions you specified may not be compatible with the updated `rive-react-native` version. Always check the default versions in the new release and test thoroughly.
88
+
89
+
### Default Behavior
90
+
91
+
By default, `rive-react-native` uses the native SDK versions specified in `package.json`:
92
+
93
+
```json
94
+
"runtimeVersions": {
95
+
"ios": "6.12.0",
96
+
"android": "10.4.5"
97
+
}
98
+
```
99
+
100
+
These versions are tested and known to work well with this version of `rive-react-native`.
101
+
102
+
### Customizing Versions
103
+
104
+
You can override these default versions using platform-specific configuration files:
105
+
106
+
#### iOS (Vanilla React Native)
107
+
108
+
Create or edit `ios/Podfile.properties.json`:
109
+
110
+
```json
111
+
{
112
+
"RiveRuntimeIOSVersion": "6.13.0"
113
+
}
114
+
```
115
+
116
+
Then run:
117
+
```bash
118
+
cd ios && pod install
119
+
```
120
+
121
+
#### Android (Vanilla React Native)
122
+
123
+
Add to `android/gradle.properties`:
124
+
125
+
```properties
126
+
Rive_RiveRuntimeAndroidVersion=10.5.0
127
+
```
128
+
129
+
#### Expo Projects
130
+
131
+
For Expo projects, use config plugins in your `app.config.ts`:
0 commit comments