Inputs

We strongly recommend controlling your Rive file through Data Binding, rather than Inputs.

For more information on creating Inputs in Rive, please refer to: Inputs.

Controlling state machine inputs

Once the Rive file is loaded and instantiated, the state machine can be queried for inputs, and these input values can be set, and in the case of triggers, fired, all programmatically.

Inputs can also be set on nested artboards at runtime, see Nested Inputs below.

Examples

Setting state machine inputs

The web runtime provides an onLoad callback that’s run when the Rive file is loaded and ready for use. We use this callback to ensure that the state machine is instantiated before we query for inputs.

<div id="button">
    <canvas id="canvas" width="1000" height="500"></canvas>
</div>
<script src="https://unpkg.com/@rive-app/canvas@2.10.3"></script>
<script>
    const button = document.getElementById('button');

    const r = new rive.Rive({
        src: 'https://cdn.rive.app/animations/vehicles.riv',
        canvas: document.getElementById('canvas'),
        autoplay: true,
        stateMachines: 'bumpy',
        onLoad: (_) => {
            // Get the inputs via the name of the state machine
            const inputs = r.stateMachineInputs('bumpy');
            // Find the input you want to set a value for, or trigger
            const bumpTrigger = inputs.find(i => i.name === 'bump');
            button.onclick = () => bumpTrigger.fire();
        },
    });
</script>

We use the stateMachineInputs function on the Rive object to retrieve the inputs. Each input will have a name and type. There are three types:

StateMachineInputType.Trigger which has a fire() function
StateMachineInputType.Number which has a value number property where you can get/set the value
StateMachineInputType.Boolean which has a value boolean property where you can get/set the value

const inputs = r.stateMachineInputs('bumpy');
inputs.forEach(i => {
    const inputName = i.name;
    const inputType = i.type;
    switch(inputType) {
        case rive.StateMachineInputType.Trigger:
            i.fire();
            break;
        case rive.StateMachineInputType.Number:
            i.value = 42;
            break;
        case rive.StateMachineInputType.Boolean:
            i.value = true;
            break;
    }
});

Examples

Setting state machine inputs

Inputs

<div id="button">
    <canvas id="canvas" width="1000" height="500"></canvas>
</div>
<script src="https://unpkg.com/@rive-app/canvas@2.10.3"></script>
<script>
    const button = document.getElementById('button');

    const r = new rive.Rive({
        src: 'https://cdn.rive.app/animations/vehicles.riv',
        canvas: document.getElementById('canvas'),
        autoplay: true,
        stateMachines: 'bumpy',
        onLoad: (_) => {
            // Get the inputs via the name of the state machine
            const inputs = r.stateMachineInputs('bumpy');
            // Find the input you want to set a value for, or trigger
            const bumpTrigger = inputs.find(i => i.name === 'bump');
            button.onclick = () => bumpTrigger.fire();
        },
    });
</script>

We use the stateMachineInputs function on the Rive object to retrieve the inputs. Each input will have a name and type. There are three types:

StateMachineInputType.Trigger which has a fire() function
StateMachineInputType.Number which has a value number property where you can get/set the value
StateMachineInputType.Boolean which has a value boolean property where you can get/set the value

const inputs = r.stateMachineInputs('bumpy');
inputs.forEach(i => {
    const inputName = i.name;
    const inputType = i.type;
    switch(inputType) {
        case rive.StateMachineInputType.Trigger:
            i.fire();
            break;
        case rive.StateMachineInputType.Number:
            i.value = 42;
            break;
        case rive.StateMachineInputType.Boolean:
            i.value = true;
            break;
    }
});

Example

Setting state machine inputs (React)

Inputs

The react runtime provides a useStateMachineInput hook to make the process of retrieving a state machine input much simpler than that of the basic web runtime.

import { useRive, useStateMachineInput } from "@rive-app/react-canvas";

export default function Simple() {
    const { rive, RiveComponent } = useRive({
        src: "https://cdn.rive.app/animations/vehicles.riv",
        stateMachines: "bumpy",
        autoplay: true,
    });

    const bumpInput = useStateMachineInput(rive, "bumpy", "bump");

    return (
        <RiveComponent
            style={{ height: "1000px" }}
            onClick={() => bumpInput && bumpInput.fire()}
        />
    );
}

Inputs

With the React Native runtime, most methods/triggers are available on the ref of the Rive component, including setting input values/triggering for state machines. In this case, there is no need to acquire an instance of an input. Simply set the input state from the Rive ref or fire an input state.

export default function StateMachine() {
    const riveRef = React.useRef<RiveRef>(null);
    // Maintain the values of your state machine in React state
    const [selectedLevel, setSelectedLevel] = useState('2');

    const setLevel = (n: number) => {
        setSelectedLevel(n.toString());
        // No need to acquire an instance of a state machine input, just set the
        // input state on the `riveRef` itself
        riveRef.current?.setInputState("Designer's Test", 'Level', n);
    };

    return (
        <SafeAreaView style={styles.safeAreaViewContainer}>
            <ScrollView contentContainerStyle={styles.container}>
                <Rive
                    resourceName={'skills'}
                    ref={riveRef}
                    autoplay={true}
                    stateMachineName="Designer's Test"
                />
                <RadioButton.Group
                    onValueChange={(newValue) => setLevel(parseInt(newValue, 10))}
                    value={selectedLevel}
                >
                    <View style={styles.radioButtonsWrapper}>
                        <View style={styles.radioButtonWrapper}>
                            <Text>{'Beginner'}</Text>
                            <RadioButton value={'0'} />
                        </View>
                        <View style={styles.radioButtonWrapper}>
                            <Text>{'Intermediate'}</Text>
                            <RadioButton value={'1'} />
                        </View>
                        <View style={styles.radioButtonWrapper}>
                            <Text>{'Expert'}</Text>
                            <RadioButton value={'2'} />
                        </View>
                    </View>
                </RadioButton.Group>
            </ScrollView>
        </SafeAreaView>
    );
}

See the React Native API’s to learn more about the parameters for .setInputState() and .fireState()

Inputs

State machine controllers are used to retrieve a state machine’s inputs which can then be used to interact with, and drive the state of a state machine.

State machine controllers require a reference to an artboard when being instantiated. The RiveAnimation widget provides a callback onInit(Artboard artboard) that is called when the Rive file has loaded and is initialized for playback:

void _onRiveInit(Artboard artboard) {}

RiveAnimation.network(
    'https://cdn.rive.app/animations/vehicles.riv',
    fit: BoxFit.cover,
    onInit: _onRiveInit,
);

In the onInit callback, you can create an instance of a StateMachineController and then retrieve the inputs you’re interested in by their name. Specific inputs can be retrieved using findInput() or all inputs with the inputs property.

SMITrigger? _bump;

void _onRiveInit(Artboard artboard) {
    // Get State Machine Controller for the state machine called "bumpy"
    final controller = StateMachineController.fromArtboard(artboard, 'bumpy');
    artboard.addController(controller!);
    // Get a reference to the "bump" state machine input
    _bump = controller.getTriggerInput('bump');
}

In the above snippet, the bump input is retrieved, which is an SMITrigger. This type of input has a fire() method to activate the trigger.

class SimpleStateMachine extends StatefulWidget {
    const SimpleStateMachine({Key? key}) : super(key: key);

    @override
    _SimpleStateMachineState createState() => _SimpleStateMachineState();
}

class _SimpleStateMachineState extends State<SimpleStateMachine> {
    SMITrigger? _bump;

    void _onRiveInit(Artboard artboard) {
        final controller = StateMachineController.fromArtboard(artboard, 'bumpy');
        artboard.addController(controller!);
        _bump = controller.getTriggerInput('bump')!;
    }

    void _hitBump() => _bump?.fire();

    @override
    Widget build(BuildContext context) {
        return Scaffold(
            appBar: AppBar(
                title: const Text('Simple Animation'),
            ),
            body: Center(
                child: GestureDetector(
                    child: RiveAnimation.network(
                        'https://cdn.rive.app/animations/vehicles.riv',
                        fit: BoxFit.cover,
                        onInit: _onRiveInit,
                    ),
                    onTap: _hitBump,
                ),
            ),
        );
    }
}

In the complete example above, every time the RiveAnimation is tapped, it fires the bump input trigger and the state machine reacts appropriately.

Note: There are two other state machine input types to be aware of as well: SMIBool and SMINumber. These both have a value property that can get and set the value.

// Example state machine input declarations
SMIBool _boolExampleInput;
SMINumber _numberExampleInput;

...

// Extracting inputs from the StateMachineController
void _onRiveInit(Artboard artboard) {
  final controller = StateMachineController.fromArtboard(artboard, 'example');
  artboard.addController(controller!);
  _boolExampleInput = controller.getBoolInput('exampleBool')!;
  _numberExampleInput = controller.getNumberInput('exampleNum')!;
}

...

// Getting/setting state machine input values
if (_boolExampleInput.value == false) {
  _boolExampleInput.value = true;
}
if (_numberExampleInput.value >= 100) {
  _numberExampleInput.value = 0;
}

Inputs

Setting input values for state machines goes through the RiveViewModel instantiated in the View class.

.setInput()

inputName (String) - Name of the input on a state machine to set a value for
value (Bool, Float, or Double) - value to set for the associated inputName

triggerInput()

inputName (String) - Name of the input on a state machine to trigger

// Example of a number input
starsVM.setInput("Rating Changed", value: 5)

// Example of a boolean input
toggleVM.setInput("Switch Flipped", value: true)

// Example of a trigger input
confettiVM.triggerInput("Celebrate")

Inputs

Just like other methods within the rive-android runtime, use the view to set values on a state machine input. In this case, there is no need to grab references to state machine input instances to set values.

There are 3 different methods to set input values or trigger inputs for number, boolean, and trigger inputs respectively:

.setNumberState(stateMachineName: String, inputName: String, value: Float)
.setBooleanState(stateMachineName: String, inputName: String, value: Boolean)
.fireState(stateMachineName: String, inputName: String)

// i.e Set input state on a number input
animationView.setNumberState("Designer's Test", "Level", 0f)

// i.e Set boolean state on a boolean input
animationView.setBooleanState("Boolean test", "foo", true)

// i.e Fire a trigger input
animationView.fireState("Trigger test", "fireInput");

Nested Inputs

You can control the inputs of Nested Artboards at runtime. These inputs are not on the main artboard but on a nested artboard. To set a nested input, you need to know the path where the input exists at an artboard level.

Example

Use the artboard’s unique hierarchy name, not the artboard’s name.
Do not include the name of the main artboard. In the example above, the path is Volume Molecule, not Menu/Volume Molecule.
Ensure the nested artboards are marked as exported in the editor to access them at runtime:

You can go as many nested artboards deep as needed. For example, the Volume Molecule artboard shown above has two nested artboards with the following unique hierarchy names:

Volume Component
FX Component

Once you go more than one nested artboard deep the path will be a / separated string of the unique hierarchy names.

If you load in the Menu artboard at runtime, and want to get/set an input on the FX Component artboard, the path will be Volume Molecule/FX Component

Do not use / in the name for your components, as that will break the search functionality at runtime.