Rive iOS

An iOS/macOS runtime library for Rive that supports both UIKit, AppKit, and SwiftUI.

The library is distributed both through Swift Package Manager and Cocoapods.

Table of contents

• :star: Rive Overview
• 🚀 Getting Started & API docs
• :mag: Supported Devices
• :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

🛠 Rive Forums

Getting started

To get started with Rive iOS, check out the following resources:

• Getting Started with Rive iOS

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

• Animation Playback
• Layout
• State Machines
• Rive Text
• Rive Events
• Loading Assets

Supported devices

Currently, this runtime library supports a minimum iOS version of 14.0+. Devices supported include iPhone, iPad, and Mac catalyst. macOS support supports a targeted version of 13.1.

Examples

Check out the Example-iOS/ folder for an example application using the Rive iOS/macOS runtime.

Open the project in XCode and ensure the selected scheme/target is set to Preview/Preview (macOS). These schemes make use of the hosted Rive package dependency. The other targets are for local development and require additional configuration and set-up. See Customizing the build schemes for a project for instructions to switch schemes, and CONTRIBUTING.md for more information.

The example showcases a number of ways to use the high-level RiveViewModel API through UIKit and SwiftUI examples, including:

• Setting a Rive file via a URL or asset in the bundle
• Setting layout and loop mode options
• Displaying single or multiple animations / artboards on one component
• Setting up and maniuplating a state machine via inputs
• ...and more!

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 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.