Fade out placeholders

rnystrom · rnystrom · commit 912bc9d460f8 · 2014-12-18T12:53:15.000-08:00
Added an API to fade out a node's placeholder when it is finished rendering. fixes facebookarchive#156
diff --git a/AsyncDisplayKit/ASDisplayNode.h b/AsyncDisplayKit/ASDisplayNode.h
@@ -338,6 +338,13 @@
  */
 @property (nonatomic, assign) BOOL placeholderEnabled;
 
+/**
+ * @abstract Toggle to fade-out the placeholder when a node's contents are finished displaying.
+ *
+ * @discussion Defaults to NO.
+ */
+@property (nonatomic, assign) BOOL placeholderFadesOut;
+
 
 /** @name Hit Testing */
 
diff --git a/AsyncDisplayKit/ASDisplayNode.mm b/AsyncDisplayKit/ASDisplayNode.mm
@@ -116,6 +116,8 @@ - (void)_initializeInstance
   _flags.implementsDrawRect = ([[self class] respondsToSelector:@selector(drawRect:withParameters:isCancelled:isRasterizing:)] ? 1 : 0);
   _flags.implementsImageDisplay = ([[self class] respondsToSelector:@selector(displayWithParameters:isCancelled:)] ? 1 : 0);
   _flags.implementsDrawParameters = ([self respondsToSelector:@selector(drawParametersForAsyncLayer:)] ? 1 : 0);
+
+  _fadeAnimationDuration = 0.1;
 }
 
 - (id)init
@@ -1133,7 +1135,19 @@ - (void)_pendingNodeDidDisplay:(ASDisplayNode *)node
   // only trampoline if there is a placeholder and nodes are done displaying
   if ([self _pendingDisplayNodesHaveFinished] && _placeholderLayer.superlayer) {
     dispatch_async(dispatch_get_main_queue(), ^{
-      [self _tearDownPlaceholderLayer];
+      void (^cleanupBlock)() = ^{
+        [self _tearDownPlaceholderLayer];
+      };
+
+      if (self.placeholderFadesOut) {
+        [CATransaction begin];
+        [CATransaction setCompletionBlock:cleanupBlock];
+        [CATransaction setAnimationDuration:_fadeAnimationDuration];
+        _placeholderLayer.opacity = 0.0;
+        [CATransaction commit];
+      } else {
+        cleanupBlock();
+      }
     });
   }
 }
@@ -1257,10 +1271,6 @@ - (void)displayDidFinish
   [self _pendingNodeDidDisplay:self];
 
   [_supernode subnodeDisplayDidFinish:self];
-
-  if (_placeholderLayer && [self _pendingDisplayNodesHaveFinished]) {
-    [self _tearDownPlaceholderLayer];
-  }
 }
 
 - (void)subnodeDisplayWillStart:(ASDisplayNode *)subnode
diff --git a/AsyncDisplayKit/Private/ASDisplayNodeInternal.h b/AsyncDisplayKit/Private/ASDisplayNodeInternal.h
@@ -61,6 +61,8 @@ void ASDisplayNodePerformBlockOnMainThread(void (^block)());
 
   _ASPendingState *_pendingViewState;
 
+  NSTimeInterval _fadeAnimationDuration;
+
   struct {
     // public properties
     unsigned synchronous:1;
diff --git a/examples/Placeholders/Sample/SlowpokeImageNode.m b/examples/Placeholders/Sample/SlowpokeImageNode.m
@@ -28,6 +28,7 @@ - (instancetype)init
 {
   if (self = [super init]) {
     self.placeholderEnabled = YES;
+    self.fadeOutPlaceholder = YES;
   }
   return self;
 }
@@ -46,8 +47,11 @@ - (UIImage *)placeholderImage
 {
   CGSize size = self.calculatedSize;
   UIGraphicsBeginImageContext(size);
+  [[UIColor whiteColor] setFill];
   [[UIColor colorWithWhite:0.9 alpha:1] setStroke];
 
+  UIRectFill((CGRect){CGPointZero, size});
+
   UIBezierPath *path = [UIBezierPath bezierPath];
   [path moveToPoint:CGPointZero];
   [path addLineToPoint:(CGPoint){size.width, size.height}];

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ - (instancetype)init`
`28`	`28`	`{`
`29`	`29`	`if (self = [super init]) {`
`30`	`30`	`self.placeholderEnabled = YES;`
	`31`	`+ self.fadeOutPlaceholder = YES;`
`31`	`32`	`}`
`32`	`33`	`return self;`
`33`	`34`	`}`
`@@ -46,8 +47,11 @@ - (UIImage *)placeholderImage`
`46`	`47`	`{`
`47`	`48`	`CGSize size = self.calculatedSize;`
`48`	`49`	`UIGraphicsBeginImageContext(size);`
	`50`	`+ [[UIColor whiteColor] setFill];`
`49`	`51`	`[[UIColor colorWithWhite:0.9 alpha:1] setStroke];`
`50`	`52`
	`53`	`+ UIRectFill((CGRect){CGPointZero, size});`
	`54`	`+`
`51`	`55`	`UIBezierPath *path = [UIBezierPath bezierPath];`
`52`	`56`	`[path moveToPoint:CGPointZero];`
`53`	`57`	`[path addLineToPoint:(CGPoint){size.width, size.height}];`