Skip to main content
Libraries are available on Voyager and Enterprise plans. Learn more about our plans and pricing.

​
Introduction

Libraries facilitate the sharing of components and their view models across Rive files. In the past, you may have relied on nested artboards and copy-paste workflows to share elements. This works for individuals, but breaks down at scale: exports bloat, versions drift, and teams lose track of changes. With Libraries:
  • Components can be published and reused across project files.
  • Updates flow downstream with version history and change notifications.
  • Teams can collaborate without worrying about mismatched assets.
Libraries are available on Voyager and Enterprise plans. Learn more about our plans and pricing.

​
Creating a Library

Any file can be made into a library. First, you’ll need to create a component and/or a view model before you can publish the file as a library. Select an artboard on the stage and use the component icon in the inspector or Shift + N to toggle its status as a component. Image With a component or view model present in the file, select the Publish Library option via the export action on the toolbar, or via the file menu. The publishing panel provides an opportunity to select which of the components, view models, and enums you’d like to be published as part of the library. Image
You can identify a library file by the icon in the tab bar and in the file browser.

​
Importing from a Library

To start using components and view models from a published library, select the library icon present in both the asset and data panels. The library panel displays alongside the hierarchy/asset/data column, and displays a list of the available libraries for the active file. Image
Currently, a Rive file can only access libraries contained within the same project. Cross-project — or workspace — libraries are coming soon. Public libraries are planned soon after that.
Selecting a library listed in the panel will present its available components, view models, and enums. Choose the elements you’d like to add to your file, and use the Add to File action in the inspector to import them. Image
You can use the version dropdown to browse and import previous iterations of libraries and their components.
Image With the chosen elements added to your file, you can access and reuse components and view models via the asset and data panels. Elements sourced from a library can be identifed by the library icon appended to the bottom-right corner of the regular icon. Image

​
Updating a Library

After publishing, you can continue to make changes, add, or remove components, view models, and enums. Republish the library via the same option in the export or file menus. Upon publishing an updated version of the library, any files that have imported elements from it will display a small badge indicating an available update. Image To update a component, right-click it in asset panel and select Library Options -> Update Component from the context menu. Choose the library elements you’d like to update and select Update Selected. Image

​
Detatching

After importing a component from a library and creating an instance of it on the stage, you may choose to detach it. Detaching a component will decouple it from the source and copy over its contents into your active file. Any references to it will be redirected to the new local copy. You may want to detach a component to make changes to it, without changing the source.
It’s not possible to re-attach a component after it has been detached.
Image

​
Export Options

By using libraries, you create a series of dependencies between files. For example, an instance of an imported component depends on the library file it came from, which in turn may depend on an image asset used within the component, or perhaps another component from a different library entirely. The export options control what and how components and any assets they depend on get exported to a riv file. These options are available across assets and components, with an additonal layer of separation for libraries specifically. To access the export options for a given component, asset, or library, select it in the asset panel and set the desired options in the inspector. Image
  • Automatic: Include this asset/component in the export if it’s being used somewhere on the stage. For assets contained within a library, this option is inherited from the source file.
  • Force Export: Export this asset/component, regardless of whether or not it’s referenced within the file.
  • Prevent Export: Don’t include this asset/component in the export, regardless of whether or not it’s referened within the file.
You may want to adjust these options to suit your needs at runtime as opposed to design-time. For example, images used within a design are to be supplied from an external source at runtime, and therefore aren’t required in the riv file. Or, you intend to use a library component across multiple Rive files at once via data binding. Exporting the library component separately and excluding from the host files prevents it from being duplicated.
Currently, the export behavior for assets within a library component can only be set at the library level, not per component. To do so, set the panel display mode to Source/Type, and select the library item in the asset panel.
Image

​
Unpublishing a Library

Use the Unpublish Library action in the file menu to prevent additional files from accessing the library and its components. Unpublishing does not remove library components from host files that had already imported them. Host files that have imported library components will retain access to previously published versions of the library. You may republish a library at any time. Image
⌘I