FBShimmering

@protocol FBShimmering <NSObject>

//! @abstract Set this to YES to start shimming and NO to stop. Defaults to NO.
@property (assign, nonatomic, readwrite, getter = isShimmering) BOOL shimmering;

//! @abstract The time interval between shimmerings in seconds. Defaults to 0.4.
@property (assign, nonatomic, readwrite) CFTimeInterval shimmeringPauseDuration;

//! @abstract The opacity of the content while it is shimmering. Defaults to 0.5.
@property (assign, nonatomic, readwrite) CGFloat shimmeringAnimationOpacity;

//! @abstract The opacity of the content before it is shimmering. Defaults to 1.0.
@property (assign, nonatomic, readwrite) CGFloat shimmeringOpacity;

//! @abstract The speed of shimmering, in points per second. Defaults to 230.
@property (assign, nonatomic, readwrite) CGFloat shimmeringSpeed;

//! @abstract The highlight length of shimmering. Range of [0,1], defaults to 1.0.
@property (assign, nonatomic, readwrite) CGFloat shimmeringHighlightLength;

//! @abstract Same as "shimmeringHighlightLength", just for downward compatibility. @deprecated
@property (assign, nonatomic, readwrite, getter = shimmeringHighlightLength, setter = setShimmeringHighlightLength:) CGFloat shimmeringHighlightWidth DEPRECATED_MSG_ATTRIBUTE("Use shimmeringHighlightLength");

//! @abstract The direction of shimmering animation. Defaults to FBShimmerDirectionRight.
@property (assign, nonatomic, readwrite) FBShimmerDirection shimmeringDirection;

//! @abstract The duration of the fade used when shimmer begins. Defaults to 0.1.
@property (assign, nonatomic, readwrite) CFTimeInterval shimmeringBeginFadeDuration;

//! @abstract The duration of the fade used when shimmer ends. Defaults to 0.3.
@property (assign, nonatomic, readwrite) CFTimeInterval shimmeringEndFadeDuration;

/**
 @abstract The absolute CoreAnimation media time when the shimmer will fade in.
 @discussion Only valid after setting {@ref shimmering} to NO.
 */
@property (assign, nonatomic, readonly) CFTimeInterval shimmeringFadeTime;

/**
 @abstract The absolute CoreAnimation media time when the shimmer will begin.
 @discussion Only valid after setting {@ref shimmering} to YES.
 */
@property (assign, nonatomic) CFTimeInterval shimmeringBeginTime;

@end

Undocumented

  • Undocumented

    Declaration

    Objective-C

    @property (getter=isShimmering, assign, readwrite, nonatomic) BOOL shimmering;

    Swift

    var isShimmering: Bool { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CFTimeInterval shimmeringPauseDuration;

    Swift

    var shimmeringPauseDuration: CFTimeInterval { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGFloat shimmeringAnimationOpacity;

    Swift

    var shimmeringAnimationOpacity: CGFloat { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGFloat shimmeringOpacity;

    Swift

    var shimmeringOpacity: CGFloat { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGFloat shimmeringSpeed;

    Swift

    var shimmeringSpeed: CGFloat { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGFloat shimmeringHighlightLength;

    Swift

    var shimmeringHighlightLength: CGFloat { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (getter=shimmeringHighlightLength,
          setter=setShimmeringHighlightLength:, assign, readwrite, nonatomic)
    CGFloat shimmeringHighlightWidth;

    Swift

    var shimmeringHighlightWidth: CGFloat { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) FBShimmerDirection shimmeringDirection;

    Swift

    var shimmeringDirection: FBShimmerDirection { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
    CFTimeInterval shimmeringBeginFadeDuration;

    Swift

    var shimmeringBeginFadeDuration: CFTimeInterval { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
    CFTimeInterval shimmeringEndFadeDuration;

    Swift

    var shimmeringEndFadeDuration: CFTimeInterval { get set }

  • @abstract The absolute CoreAnimation media time when the shimmer will fade in. @discussion Only valid after setting {@ref shimmering} to NO.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) CFTimeInterval shimmeringFadeTime;

    Swift

    var shimmeringFadeTime: CFTimeInterval { get }

  • @abstract The absolute CoreAnimation media time when the shimmer will begin. @discussion Only valid after setting {@ref shimmering} to YES.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CFTimeInterval shimmeringBeginTime;

    Swift

    var shimmeringBeginTime: CFTimeInterval { get set }