installation.md

id	title	sidebar_label
installation	Installation	Installation

Installing Reanimated requires a couple of additional steps compared to installing most of the popular react-naitve packages. Specifically on Android the setup consist of adding additional code to the main application class. The steps needed to get reanimated properly configured are listed in the below paragraphs.

Installing the package

First step is to install react-native-reanimated alpha as a dependency in your project:

yarn add react-native-reanimated

Babel plugin

Add Reanimated's babel plugin to your babel.config.js:

  module.exports = {
      ...
      plugins: [
          ...
          'react-native-reanimated/plugin',
      ],
  };

By default, Reanimated plugin generate source location using absolute path. You can configure to use relative path:

  module.exports = {
      ...
      plugins: [
          ...
          [
              'react-native-reanimated/plugin', {
                  relativeSourceLocation: true,
              },
          ]
      ],
  };

:::caution

Reanimated plugin has to be listed last.

:::

Android

No additional steps are necessary.

Proguard

If you're using Proguard, make sure to add rule preventing it from optimizing Turbomodule classes:

-keep class com.swmansion.reanimated.** { *; }
-keep class com.facebook.react.turbomodule.** { *; }

iOS

As reanimated is setup to configure and install automatically, the only thing you have to do is to run pod install in the ios/ directory. Note that the auto-installation setup works for the standard React Naitve apps, if you have problems setting it up with a custom setup (e.g. brownfield) please start a new issue where we can find a way to guide you through that process.

Sample React-Native project configured with Reanimated

If you have troubles configuring Reanimated in your project, or just want to try the library without the need of setting it up ion a fresh project we recommend checking our Reanimated Playground repo, which is essentially a fresh React-Native app with Reanimated library installed and configured properly. [Visit the Playground repo here] or copy the command below to do a git clone: