Adding animationsOnInitialMount

zeuspnt · Jun 25, 2015 · db86526 · db86526
1 parent eb9c941
commit db86526
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 2 deletions.
diff --git a/ComponentKit/Core/CKComponent.mm b/ComponentKit/Core/CKComponent.mm
@@ -179,6 +179,11 @@ - (void)childrenDidMount
 
 #pragma mark - Animation
 
+- (std::vector<CKComponentAnimation>)animationsOnInitialMount
+{
+  return {};
+}
+
 - (std::vector<CKComponentAnimation>)animationsFromPreviousComponent:(CKComponent *)previousComponent
 {
   return {};

diff --git a/ComponentKit/Core/CKComponentController.mm b/ComponentKit/Core/CKComponentController.mm
@@ -54,7 +54,10 @@ @implementation CKComponentController
 {
   CKComponentControllerState _state;
   BOOL _updatingComponent;
+  BOOL _performedInitialMount;
   CKComponent *_previousComponent;
+  std::vector<CKPendingComponentAnimation> _pendingAnimationsOnInitialMount;
+  std::vector<CKAppliedComponentAnimation> _appliedAnimationsOnInitialMount;
   std::vector<CKPendingComponentAnimation> _pendingAnimations;
   std::vector<CKAppliedComponentAnimation> _appliedAnimations;
 }
@@ -87,6 +90,12 @@ - (void)componentWillMount:(CKComponent *)component
     case CKComponentControllerStateUnmounted:
       _state = CKComponentControllerStateMounting;
       [self willMount];
+      if (!_performedInitialMount) {
+        _performedInitialMount = YES;
+        for (const auto &animation : [component animationsOnInitialMount]) {
+          _pendingAnimationsOnInitialMount.push_back({animation, animation.willRemount()});
+        }
+      }
       break;
     case CKComponentControllerStateMounted:
       _state = CKComponentControllerStateRemounting;
@@ -108,6 +117,11 @@ - (void)componentDidMount:(CKComponent *)component
     case CKComponentControllerStateMounting:
       _state = CKComponentControllerStateMounted;
       [self didMount];
+      for (const auto &pendingAnimation : _pendingAnimationsOnInitialMount) {
+        const CKComponentAnimation &anim = pendingAnimation.animation;
+        _appliedAnimationsOnInitialMount.push_back({anim, anim.didRemount(pendingAnimation.context)});
+      }
+      _pendingAnimationsOnInitialMount.clear();
       break;
     case CKComponentControllerStateRemounting:
       _state = CKComponentControllerStateMounted;
@@ -176,6 +190,10 @@ - (void)_relinquishView
 
 - (void)_cleanupAppliedAnimations
 {
+  for (const auto &appliedAnimation : _appliedAnimationsOnInitialMount) {
+    appliedAnimation.animation.cleanup(appliedAnimation.context);
+  }
+  _appliedAnimationsOnInitialMount.clear();
   for (const auto &appliedAnimation : _appliedAnimations) {
     appliedAnimation.animation.cleanup(appliedAnimation.context);
   }

diff --git a/ComponentKit/Core/CKComponentSubclass.h b/ComponentKit/Core/CKComponentSubclass.h
@@ -105,6 +105,14 @@ extern CGSize const kCKComponentParentSizeUndefined;
  */
 - (BOOL)canPerformAction:(SEL)action withSender:(id)sender;
 
+/**
+ Override to return a list of animations that will be applied to the component when it is first mounted.
+
+ @warning If you override this method, your component MUST declare a scope (see CKComponentScope). This is used to
+ identify equivalent components between trees.
+ */
+- (std::vector<CKComponentAnimation>)animationsOnInitialMount;
+
 /**
  Override to return a list of animations from the previous version of the same component.
 

diff --git a/ComponentKit/Core/Scope/CKComponentScopeHandle.mm b/ComponentKit/Core/Scope/CKComponentScopeHandle.mm
@@ -137,8 +137,10 @@ static Class controllerClassForComponentClass(Class componentClass)
   if (it == cache->end()) {
     Class c = NSClassFromString([NSStringFromClass(componentClass) stringByAppendingString:@"Controller"]);
 
-    // If you override animationsFromPreviousComponent: then we need a controller.
-    if (c == nil && CKSubclassOverridesSelector([CKComponent class], componentClass, @selector(animationsFromPreviousComponent:))) {
+    // If you override animationsFromPreviousComponent: or animationsOnInitialMount then we need a controller.
+    if (c == nil &&
+        (CKSubclassOverridesSelector([CKComponent class], componentClass, @selector(animationsFromPreviousComponent:)) ||
+         CKSubclassOverridesSelector([CKComponent class], componentClass, @selector(animationsOnInitialMount)))) {
       c = [CKComponentController class];
     }
 

diff --git a/ComponentKitTests/Scope/CKStateScopeComponentBuilderTests.mm b/ComponentKitTests/Scope/CKStateScopeComponentBuilderTests.mm
@@ -42,6 +42,7 @@ @interface CKMonkeyComponentWithAnimations : CKComponent
 
 @implementation CKMonkeyComponentWithAnimations
 - (std::vector<CKComponentAnimation>)animationsFromPreviousComponent:(CKComponent *)previousComponent { return {}; }
+- (std::vector<CKComponentAnimation>)animationsOnInitialMount { return {}; }
 @end
 
 #pragma mark - Tests