Skip to main content

Documentation Index

Fetch the complete documentation index at: https://rive-binding-data.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

For example, if you have a teamName property bound to a text run in your scene, changing the teamName value updates the displayed text automatically. You can change property values in the editor or at runtime, allowing you to create dynamic experiences that adapt to each user. Bindings are not limited to visual properties. You can bind values throughout your file, including transforms, animation speeds, converter values, script inputs, transition condition values, and more. This allows the same data to drive behavior, animation, and logic across your scene, helping keep everything in sync.

Binding a Property

Let’s control the X position of a circle using circleX, which is a Number property in our View Model. Bind a property
1

Bind the property

With your circle selected, right-click the X field, and select Data Bind.
2

Select the property

In the Property dropdown, select circleX.
The X field should now be highlighted in green, indicating that it’s bound to a value. The circle’s horizontal position is now driven by the circleX property. Any time the property’s value changes, the circle updates automatically. Bind a property
If the field has a yellow border, there is a problem with the binding.In most cases, the property type is incompatible with the target value. For example, the X position of an element can only be bound to a Number property.
Previewing BindingsBy default, your data only controls your elements when the state machine is playing.To preview your data-bound values, turn on the Data Binding Preview Toggle.Preview data binding

Updating a Binding

Right-click the bound element and select Update Bind. Update a binding

Removing a Binding

Right-click the bound element and select Unbind. Remove a binding

Binding Options

Each binding has the following properties.

Property

The View Model property the target is connected to. Property field

Path

When binding to nested View Models, there may be multiple properties with the same name available. The path determines which specific property instance the binding should use. Preview data binding See also Absolute vs Relative Binding.

Bind Direction

By default, the View Model property (source) controls the bound element or value (target), but it can also work the other way around.

Target to Source

When a binding has Target to Source toggled on, a change to the element will update the view model property. Target to source

Bidirectional

A change to the view model property will update the element AND a change to the element will update the view model property. Bidirectional data binding Clicking the Bidirectional toggle multiple times will cycle between Bidirectional (prefer target value) and Bidirectional (prefer source value). In rare cases, both the source and target may change at the same time. This setting determines which value wins when a conflict occurs.

Bind Once

When Bind Once is enabled, the binding only applies the value a single time when the scene starts or the binding is created. Bind once After the initial value is applied, future changes to the source or target are ignored.

Absolute vs Relative Binding

By default, new data binding connections are created as absolute binds.
  • Absolute Binding: The binding points to a specific property instance within the View Model hierarchy.
  • Relative Binding: The binding searches for a property with a matching name relative to the current context.