Skip to content

feature-support.mdx

Latest commit

 

History

History
151 lines (126 loc) · 6.65 KB

feature-support.mdx

File metadata and controls

151 lines (126 loc) · 6.65 KB
Raw
title Feature Support
description

import { FeatureSupportGroup } from '/snippets/feature-support.jsx'

As the Rive Editor evolves, some new features require updates to the Rive runtimes. In certain cases, this may introduce new or modified APIs. We recommend staying on the latest runtime version to ensure compatibility, bug fixes, and performance improvements.

Use the table below to verify whether a feature used in your .riv file is supported by your target runtime.

Certain features require the use of the Rive Renderer at runtime. See our documentation on [choosing a renderer](/runtimes/choose-a-renderer/).

Currently, the only feature that requires the Rive Renderer is Vector Feathering.

When a feature requires API changes, migration notes will be included below.

Feature Support by Runtime

Runtimes

Choose between @rive-app/webgl2 and @rive-app/canvas, with guidance on performance, package size, and when to use canvas-lite. For better performance and the latest features, like vector feathering, we recommend using the WebGL2 runtime, which uses the Rive Renderer.

Lite Runtimes

This lightweight version uses the same API as `@rive-app/canvas`, but excludes certain features to reduce bundle size. This lightweight version uses the same API as `@rive-app/react-canvas`, but excludes certain features to reduce bundle size.

Legacy Runtimes

The `@rive-app/webgl` runtime is deprecated. For better performance and the latest features, use `@rive-app/webgl2`. The `@rive-app/react-webgl` runtime is deprecated. For better performance and the latest features, use `@rive-app/react-webgl2`. The `rive-react-native` runtime is deprecated. For better performance and the latest features, use `rive-nitro-react-native`. 
    [Migration guide](/feature-support#react-native-legacy)
</Warning>

Runtime Support by Feature

A green checkmark (✅) indicates that a feature is supported in all current runtimes. A yellow circle (🟡) indicates that support varies by runtime or renderer.

Differences may reflect:

  • Platform or SDK limitations where a feature cannot be supported
  • Staggered releases as features roll out across runtimes, or
  • Lightweight (“lite”) builds that intentionally omit some features to reduce package size.
A feature may still be considered fully supported even if it is unavailable in legacy runtimes.

Features

Accessibility voice over support with [Semantics](/editor/accessibility/semantics). Support for Rive files with [Scripting](/scripting). Data binding lists, images, and artboards were added after initial data binding support. 
See [Data Binding Overview](/editor/data-binding/overview) and [Data Binding for Runtimes](/runtimes/data-binding).
See [Data Binding Overview](/editor/data-binding/overview) and [Data Binding for Runtimes](/runtimes/data-binding). See [N-Slicing](/editor/layouts/n-slicing). Allows Rive to automatically update the artboard size as the underlying view/canvas/widget/texture size changes. See [Layouts](/editor/layouts/layouts-overview). Allows Rive to use a fallback font if a glyph is not available. A default font is automatically chosen, or you can optionally configure the desired fallback font based on various options. See [Fallback Fonts](/runtimes/text#fallback-fonts). Enables randomizing transitions between animations and customizing the probability. See [Rive Events](/runtimes/rive-events) and [Audio Events](/editor/events/audio-events). See [Loading Assets](/runtimes/loading-assets). See [Text](/runtimes/text).

Legacy Features

Listening to [Rive Events](/runtimes/rive-events) at runtime is deprecated and will be removed in future versions. 
    Use [Data Binding](/runtimes/data-binding) to listen for triggers or changes to properties instead.
</Warning>
Setting text, including [nested text](/runtimes/text#read-update-nested-text-runs-at-runtime), at runtime is deprecated and will be removed in a future version. 
    Instead, use [Data Binding](/runtimes/data-binding) to update a string, which is bound to a text run.
</Warning>