lottie-ios/Documentation/MIGRATING.md

Lottie is a mobile library for Android and iOS that parses Adobe After Effects animations exported as json with bodymovin and renders the vector animations natively on mobile and through React Native!

# Migrating from Lottie 2.5.3(OBJC) -> 3.0 (SWIFT)

Lottie 3.0 is a complete rewrite of Lottie in Swift. Because of this there are some minor API changes. This guide should help you through migrating code from Lottie 2.5.2 to 3.0

For continued support and contribution to Objective-C please point to the official Lottie Objective-C Branch [Here](https://github.com/airbnb/lottie-ios/tree/lottie/objectiveC)

Swift discourages the use of Prefix for names. A lot of the api changes are just the removal of `LOT` from the class name. Below is a complete list of API changes.

To use Lottie Swift in an Objective-C project read Apple's official documentation [here](https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_swift_into_objective-c)

## Class Changes
| Lottie 2.5.2 | Lottie 3.0+ |
| --:|  --:|
|`LOTAnimationView`|`AnimationView`|
|`LOTComposition`|`Animation`|
|`LOTKeypath`|`AnimationKeypath`|
|`LOTAnimationCache`|`AnimationCacheProvider`|
|`LOTCacheProvider`|`AnimationImageProvider`|
|`LOTValueDelegate`|`AnyValueProvider`|
|`LOTAnimatedControl`|`AnimatedControl`|
|⛔️|`AnimatedButton`|
|`LOTAnimatedSwitch`|`AnimatedSwitch`|

## Method Changes

| Lottie 2.5.2 | Lottie 3.0+ |
| --:|  --:|
|`LOTAnimationView.sceneModel`|`AnimationView.animation`|
|`LOTAnimationView.loopAnimation`|`AnimationView.loopMode`|
|`LOTAnimationView.autoReverseAnimation`|`AnimationView.loopMode`|
|`LOTAnimationView.animationProgress`|`AnimationView.currentProgress`|
|`LOTAnimationView.cacheEnable`|⛔️(Cache is passed in on init)|
|`LOTAnimationView.setValueDelegate:forKeypath:`|`AnimationView.setValueProvider:keypath:`|
|`LOTComposition.animationNamed:`|`Animation.named:`|
|`LOTComposition.animationWithFilePath:`|`Animation.filepath:`|
|`LOTComposition.animationNamed:inBundle:`|`Animation.named:bundle:`|
|`LOTComposition.animationFromJSON:`|⛔️(`Animation` is Encodable/Decodable from data on it's own.)|
<!--stackedit_data:
eyJoaXN0b3J5IjpbLTE1NDEwODc0Ml19
-->