Feature Support
Runtime versions that start supporting new Rive features
As our Rive editor grows to support more features and toolsets in making Rive assets, sometimes our runtimes need to be updated to support these updates. These editor additions may or may not introduce an API change or feature. You may need to update the runtime version to support these features. Check below to see if a feature your Rive asset takes advantage of is supported at runtime yet or not. We generally recommend you are on the latest version of the runtimes to take advantage of follow-on bug fixes and new features.
We may include notes on migrating to newer versions if a new feature warrants recent API changes.
To receive reported Rive Events at runtime, bump to the appropriate versions noted below to support this new feature.
Runtime | Version |
|---|---|
(Web) @rive-app/canvas and @rive-app/webgl | ✅ >= 2.4.3 |
React | ✅ >= 4.3.3 |
React Native | ✅ >= 6.1.0 |
Flutter | ✅ >= 0.11.17 |
iOS/macOS | ✅ >= 5.3.1 |
Android | ✅ >= 8.4.0 |
C++ | ✅ |
To take advantage of basic Text support at runtime, bump to the appropriate versions noted below to support this new feature.
Runtime | Version |
|---|---|
(Web) @rive-app/canvas and @rive-app/webgl | ✅ >= 2.1.3 |
React | ✅ >= 4.1.3 |
React Native | ✅ >= 6.0.3 |
Flutter | ✅ >= 0.11.14 |
iOS/macOS | ✅ >= 5.1.5 |
Android | ✅ >= 8.1.3 |
C++ | ✅ |
Note that we will proactively update the above versions as additional APIs on runtimes expose ways to dynamically set text (high and low-level), among other related features.
To take advantage of follow path at runtime, bump to the appropriate versions noted below to support this new feature.
Runtime | Version |
|---|---|
(Web) @rive-app/canvas and @rive-app/webgl | ✅ >= 1.2.4 |
React | ✅ >= 3.0.55 |
React Native | ✅ >= 5.0.0 |
Flutter | ✅ >= 0.11.6 |
iOS/macOS | ✅ >= 4.0.5 |
Android | ✅ >= 6.0.1 |
C++ | ✅ |
To take advantage of Interpolation on States at runtime, bump to the appropriate versions noted below to support this new feature.
Runtime | Version |
|---|---|
(Web) @rive-app/canvas and @rive-app/webgl | ✅ >= 1.2.1 |
React | ✅ >= 3.0.54 |
React Native | ✅ >= 4.1.2 |
Flutter | ✅ >= 0.11.4 |
iOS/macOS | ✅ >= 4.0.4 |
Android | ✅ >= 5.1.5 |
C++ | ✅ |
To allow any Joystick configuration from the editor to reflect at runtime, bump to the appropriate versions noted below to support this new feature.
Runtime | Version |
|---|---|
(Web) @rive-app/canvas and @rive-app/webgl | ✅ >= 1.1.9 |
React | ✅ >= 3.0.49 |
React Native | ✅ >= 4.1.0 |
Flutter | ✅ >= 0.11.1 |
iOS | ✅ >= 4.0.1 |
Android | ✅ >= 5.0.0 |
C++ | ✅ |
To take advantage of Solos at runtime, bump to the appropriate versions noted below to support this new feature.
Runtime | Version |
|---|---|
(Web) @rive-app/canvas and @rive-app/webgl | ✅ >= 1.1.2 |
React | ✅ >= 3.0.42 |
React Native | ✅ >= 4.0.4 |
Flutter | ✅ >= 0.10.4 |
iOS | ✅ >= 3.1.9 |
Android | ✅ >= 4.4.0 |
C++ | ✅ |
If you set speed values on states in the state machine, bump to the appropriate versions noted below for the runtime being used to support this new feature.
Runtime | Version |
|---|---|
(Web) @rive-app/canvas | ✅ >= 1.0.102 |
(Web) @rive-app/webgl | ✅ >= 1.0.98 |
React | ✅ >= 3.0.38 |
React Native | ✅ >= 4.0.1 |
Flutter | ✅ >= 0.10.3 |
iOS | ✅ >= 3.1.7 |
Android | ✅ >= 4.2.7 |
C++ | ✅ |
If you use the timeline graph editor in the Rive editor and export a
.riv file for runtime usage, bump to the appropriate versions noted below for the runtime being used to support this new feature.Runtime | Version |
|---|---|
(Web) @rive-app/canvas | ✅ >= 1.0.97 |
(Web) @rive-app/webgl | ✅ >= 1.0.93 |
React | ✅ >= 3.0.34 |
React Native | ✅ >= 4.0.1 |
Flutter | ✅ >= 0.10.0 |
iOS | ✅ >= 3.1.3 |
Android | ✅ >= 4.2.2 |
C++ | ✅ |
Runtime | Version |
|---|---|
(Web) @rive-app/canvas | ✅ >= 1.0.65 |
(Web) @rive-app/webgl | ✅ >= 1.0.62 |
React | ✅ >= 3.0.6 |
React Native | ✅ >= 3.0.38 |
Flutter | ✅ >= 0.9.0 |
iOS | ✅ >= 2.0.21 |
Android | ✅ >= 3.0.8 |
C++ | ✅ |
Notes
rive-react- Starting inv3.0.0the React runtime has split into two different published packages;@rive-app/react-canvasand@rive-app/react-webgl, each wrapping the respective@rive-app/canvasand@rive-app/webglweb runtimes. We recommend using@rive-app/react-canvas@rive-app/webgl- There is a new flag here,useOffscreenRendererwhich is off by default. This flag will allow you to work around the various browser constraints on the number of WebGL contexts created. We highly recommend setting this option totruewhen instantiating Rive in the high-level API. See more here: https://github.com/rive-app/rive-wasm#other-notes.rive-react-native- Starting inv3.0.0, it will have a minimum iOS14.0support
No extra code is needed to support listeners, and you do not need to invoke listeners via event listener/detector code at runtime. If the Rive file has a listener as part of the state machine at design time, the runtime library has implicit event listener/detector code to trigger the listeners at the appropriate time
Runtime | Version |
|---|---|
(Web) @rive-app/canvas | ✅ >= 1.0.47 |
(Web) @rive-app/webgl | ✅ >= 1.0.44 |
React | ✅ >= 3.0.1 |
React Native | ✅ >= 2.1.37 |
Flutter | ✅ >= 0.8.4 |
iOS | ✅ >= 1.0.18 |
Android | ✅ >= 2.0.24 |
C++ | ✅ |
Notes
rive-react- Starting inv3.0.0the React runtime has split into two different published packages;@rive-app/react-canvasand@rive-app/react-webgl, each wrapping the respective@rive-app/canvasand@rive-app/webglweb runtimes. We recommend using@rive-app/react-canvas@rive-app/webgl- There is a new flag here,useOffscreenRendererwhich is off by default. This flag will allow you to work around the various browser constraints on the number of WebGL contexts created. We highly recommend setting this option totruewhen instantiating Rive in the high-level API. See more here: https://github.com/rive-app/rive-wasm#other-notes- Regarding web-based runtimes and meshes:
- Keep in mind that as meshes grow across larger screen areas, they become more resource-heavy on some devices
- Avoid complex transforms repeatedly on the
<canvas>elements that display Rive animations (or<RiveComponent />in the React runtimes) - We recommend using
@rive-app/webglto display mesh on Firefox for best performance
Runtime | Version |
|---|---|
**(Web) @rive-app/canvas | ✅ >= 1.0.2 |
**(Web) @rive-app/webgl | ✅ >= 1.0.2 |
**React | ✅ >= 0.0.28 |
React Native | ✅ >= 2.1.36 |
Flutter | ✅ >= 0.8.1 |
iOS | ✅ >= 1.0.1 |
Android | ✅ >= 2.0.5 |
C++ | ✅ |
Notes
- For the web runtimes, we have deprecated
rive-jsand moved to a multi-package setup for a JS runtime that runs against thecontext2dandwebglrenderer:- Note that the new web runtime packages all support raster assets, and the high-level JS API did not change in this migration
@rive-app/canvas- Renders Rive with aCanvasRenderingContext2Drenderer@rive-app/webgl- Renders Rive with aWebGLRenderingContextrenderer.- We recommend using the
@rive-app/canvasdependency, but check here to see which might fit your needs better
Last modified 5d ago