Lottie React Native

Lottie component for React Native (iOS,Android,andWindows)

Lottie is an ecosystem of libraries for parsingAdobe After Effectsanimations exported as JSON withbodymovinand rendering them natively!

For the first time, designers can createand shipbeautiful animations without an engineer painstakingly recreating it by hand.

Installing

Breaking Changes in v6!

We've made some significant updates in version 6 that may impact your current setup. To get all the details about these changes, check out thechangelog.

Stay informed to ensure a seamless transition to the latest version. Thank you!

iOS and Android

• Installlottie-react-native(latest):

yarn add lottie-react-native

Go to your ios folder and run:

pod install

Windows (React Native >= 0.63)

Install the `lottie-react-native` npm package. (Click to expand)

Add the following to the end of your project file. For C# apps, this should come after anyMicrosoft.Windows.UI.Xaml.CSharp.targetsincludes. For C++ apps, it should come after anyMicrosoft.Cpp.targetsincludes.

<PropertyGroupLabel="LottieReactNativeProps">
<LottieReactNativeDir>$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), 'node_modules\lottie-react-native\package.json'))\node_modules\lottie-react-native</LottieReactNativeDir>
</PropertyGroup>
<ImportGroupLabel="LottieReactNativeTargets">
<ImportProject="$(LottieReactNativeDir)\src\windows\cppwinrt\PropertySheets\LottieGen.Auto.targets"/>
</ImportGroup>

Add the LottieReactNative.vcxproj file to your Visual Studio solution to ensure it takes part in the build.

For C# apps, you'll need to install the following packages through NuGet:

• LottieGen.MsBuild
• Microsoft.UI.Xaml
• Win2D.uwp
• Microsoft.Toolkit.Uwp.UI.Lottie
  • This package is used for loading JSON dynamically. If you only need codegen animation, you can set<EnableLottieDynamicSource>false</EnableLottieDynamicSource>in your project file and omit this reference.

For C++ apps, you'll need these NuGet packages:

• LottieGen.MsBuild
• Microsoft.UI.Xaml

WinUI 2.6 (Microsoft.UI.Xaml 2.6.0) is required by default. Overriding this requires creating a Directory.Build.props file in your project root with a<WinUIVersion>property.

In your application code where you set up your React Native Windows PackageProviders list, add the LottieReactNative provider:

// C#
PackageProviders.Add(newLottieReactNative.ReactPackageProvider(newAnimatedVisuals.LottieCodegenSourceProvider()));

//C++
#include<winrt/LottieReactNative.h>
#include<winrt/AnimatedVisuals.h>

...

PackageProviders().Append(winrt::LottieReactNative::ReactPackageProvider(winrt::AnimatedVisuals::LottieCodegenSourceProvider()));

Codegen animations are supported by adding LottieAnimation items to your project file. These will be compiled into your application and available at runtime by name. For example:

<!--.vcxproj or.csproj-->
<ItemGroup>
<LottieAnimationInclude="Assets/Animations/MyAnimation.json"Name="MyAnimation"/>
</ItemGroup>

// js
<LottieViewsource={"MyAnimation"}/>

Codegen is available to both C# and C++ applications. Dynamic loading of JSON strings at runtime is currently only supported in C# applications.

Usage

Lottie can be used in a declarative way:

importReactfrom"react";
importLottieViewfrom"lottie-react-native";

exportdefaultfunctionAnimation(){
return(
<LottieViewsource={require("../path/to/animation.json")}autoPlayloop/>
);
}

Additionally, there is an imperative API which is sometimes simpler.

importReact,{useEffect,useRef}from"react";
importLottieViewfrom"lottie-react-native";

exportdefaultfunctionAnimationWithImperativeApi(){
constanimationRef=useRef<LottieView>(null);

useEffect(()=>{
animationRef.current?.play();

// Or set a specific startFrame and endFrame with:
animationRef.current?.play(30,120);
},[]);

return(
<LottieView
ref={animationRef}
source={require("../path/to/animation.json")}
/>
);
}

Lottie's animation view can be controlled by either React Native Animated or Reanimated API.

importReact,{useEffect,useRef,Animated}from"react";
import{Animated,Easing}from"react-native";
importLottieViewfrom"lottie-react-native";

constAnimatedLottieView=Animated.createAnimatedComponent(LottieView);

exportdefaultfunctionControllingAnimationProgress(){
constanimationProgress=useRef(newAnimated.Value(0));

useEffect(()=>{
Animated.timing(animationProgress.current,{
toValue:1,
duration:5000,
easing:Easing.linear,
useNativeDriver:false,
}).start();
},[]);

return(
<AnimatedLottieView
source={require("../path/to/animation.json")}
progress={animationProgress.current}
/>
);
}

Changing color of layers:

NOTE: This feature may not work properly on Android. We will try fix it soon.

importReactfrom"react";
importLottieViewfrom"lottie-react-native";

exportdefaultfunctionChangingColorOfLayers(){
return(
<LottieView
source={require("../path/to/animation.json")}
colorFilters={[
{
keypath:"button",
color:"#F00000",
},
{
keypath:"Sending Loader",
color:"#F00000",
},
]}
autoPlay
loop
/>
);
}

API

You can find the full list of props and methods available in ourAPI document.These are the most common ones:

Prop	Description	Default
source	Mandatory- The source of animation. Can be referenced as a local asset by a string, or remotely with an object with auriproperty, or it can be an actual JS object of an animation, obtained (for example) with something likerequire('../path/to/animation.json').	None
style	Style attributes for the view, as expected in a standardView.	You need to set it manually. Refer to thispull request.
loop	A boolean flag indicating whether or not the animation should loop.	true
autoPlay	A boolean flag indicating whether or not the animation should start automatically when mounted. This only affects the imperative API.	false
colorFilters	An array of objects denoting layers by KeyPath and a new color filter value (as hex string).	[]

More...

Troubleshooting

Not all After Effects features are supported by Lottie. If you notice there are some layers or animations missing checkthis listto ensure they are supported.

More

View more documentation, FAQ, help, examples, and more atairbnb.io/lottie