rive-wasm

[Build Status] [Discord badge] [Twitter handle]

Rive Web

[Rive hero image]

A JavaScript/TypeScript and Web Assembly (WASM) runtime library for Rive.

This library allows full control over Rive files with a high-level API for hooking up many simple interactions and animations, as well as a low-level API that allows you to drive your own render loop to create multiple artboards, animations, and state machines all in one canvas.

Table of contents

• :star: Rive Overview
• 🚀 Getting Started & API docs
• :mag: Supported Browsers
• :thread: Threads and the replay worker
• :books: Examples
• :runner: Migration Guides
• 👨‍💻 Contributing
• :question: Issues

Rive overview

Rive is a real-time interactive design and animation tool that helps teams create and run interactive animations anywhere. Designers and developers use our collaborative editor to create motion graphics that respond to different states and user inputs. Our lightweight open-source runtime libraries allow them to load their animations into apps, games, and websites.

:house_with_garden: Homepage

:blue_book: Rive docs

Getting started

Follow along with the link below for a quick start in getting Rive JS integrated into your web applications.

• Getting Started with Rive in Web
• API documentation

For more information, see the Runtime sections of the Rive help documentation:

• Layout
• State Machines
• Data Binding
• Rive Events
• Loading Assets

Supported browsers

Rive can be used in all major browsers. We're constantly working to improve performance with our renderer so that animations playback smoothly for all.

Threads and the replay worker

@rive-app/webgl2-threads loads a threaded build on pages that are cross origin isolated. There, instances created with enableGPUCanvas: true hand their canvas to one worker shared by every instance on the page: each frame advances and records on the page's thread while the worker replays the previous frame on the GPU, so the two no longer add up on the page's thread. This is on by default wherever the browser can draw WebGL2 on a transferred OffscreenCanvas.

• Turn it off for the whole page with RuntimeLoader.setReplayWorker(false) before the runtime loads, or for one instance with useReplayWorker: false. Both keep replay on the page's thread, as do builds without threads, pages that are not isolated, and browsers without WebGL2 on OffscreenCanvas.
• A canvas handed to the worker stays with it. Setting its width and height properties still resizes it (the browser owns its attributes from then on), but the page can no longer get a context from it, and any later instance on that canvas renders through the worker too, reusing the same WebGL context.
• Images in those files decode on the worker, off the page's thread.
• The page records at most two frames ahead of the worker and skips a frame rather than queue more; the next frame advances by the time skipped.

Examples

Check out some of the demos using this JS/WASM runtime in the Rive documentation.

Awesome Rive

For even more examples and resources on using Rive at runtime or in other tools, checkout the awesome-rive repo.

Migration guides

Using an older version of the runtime and need to learn how to upgrade to the latest version? Check out the migration guides below in our help center that help guide you through major version bumps; breaking changes and all!

Migration guides

Contributing

We love contributions! Check out our contributing docs to get more details into how to run this project, the examples, and more all locally.

Issues

Have an issue with using the runtime, or want to suggest a feature/API to help make your development life better? Log an issue in our issues tab! You can also browse older issues and discussion threads there to see solutions that may have worked for common problems.