Feature Support

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.

Nested Inputs

To add support for setting nested inputs, bump the appropriate versions noted below to support this new feature. This feature enables setting inputs on nested artboards (components), see Nested Inputs.

Randomization

To add support for Randomization, bump the appropriate versions noted below to support this new feature. This feature enables randomizing transitions between animations and customizing the probability.

Rive Audio

To add support for Rive Audio, bump the appropriate versions noted below to support this new feature. For more information, see and .

Nested Inputs and Nested Events

To add support for nested inputs and nested events, bump the appropriate versions noted below to support this new feature. For more information, see .

Out-of-band Assets

To load assets dynamically, instead of embedded in the riv file, bump the appropriate versions noted below to support this new feature. For runtime specific information, see .

Rive Events Support

To receive reported Rive Events at runtime, bump to the appropriate versions noted below to support this new feature. For runtime specific information, see .

Text Support

To take advantage of basic Text support at runtime, bump to the appropriate versions noted below to support this new feature. For runtime specific information, see .

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.

Follow Path Support

To take advantage of follow path at runtime, bump to the appropriate versions noted below to support this new feature.

Interpolation on States Support

To take advantage of Interpolation on States at runtime, bump to the appropriate versions noted below to support this new feature.

Joystick Support

To allow any Joystick configuration from the editor to reflect at runtime, bump to the appropriate versions noted below to support this new feature.

Solo Support

To take advantage of Solos at runtime, bump to the appropriate versions noted below to support this new feature.

Speed on States Support

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.

Graph Editor Support

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.

Listeners Support

Notes

• rive-react - Starting in v3.0.0 the React runtime has split into two different published packages; @rive-app/react-canvas and @rive-app/react-webgl, each wrapping the respective @rive-app/canvas and @rive-app/webgl web runtimes. We recommend using @rive-app/react-canvas

• @rive-app/webgl - There is a new flag here, useOffscreenRenderer which 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 to true when instantiating Rive in the high-level API. See more here: https://github.com/rive-app/rive-wasm#other-notes.

• rive-react-native - Starting in v3.0.0, it will have a minimum iOS 14.0 support

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

Mesh Deformation Support

Notes

• rive-react - Starting in v3.0.0 the React runtime has split into two different published packages; @rive-app/react-canvas and @rive-app/react-webgl, each wrapping the respective @rive-app/canvas and @rive-app/webgl web runtimes. We recommend using @rive-app/react-canvas

• @rive-app/webgl - There is a new flag here, useOffscreenRenderer which 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 to true when 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/webgl to display mesh on Firefox for best performance

Raster Asset Support

Notes

• For the web runtimes, we have deprecated rive-js and moved to a multi-package setup for a JS runtime that runs against the context2d and webgl renderer:

  • 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 a CanvasRenderingContext2D renderer

  • @rive-app/webgl - Renders Rive with a WebGLRenderingContext renderer.

  • We recommend using the @rive-app/canvas dependency, but check here to see which might fit your needs better