Skip to content

Commit

Permalink
Updated readme and documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Łukasz Śliwiński committed Apr 1, 2017
1 parent 248d59d commit d3b1730
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -61,6 +61,7 @@ The component is documented in code, also look into example for more details.
* `subviewsParallaxMode` - enum that allow you to configure parallax effect for subviews of the `ParallaxView`
* `shadowPanDeviation` - maximal value of points that shadow of the `ParallaxView` will be moved during parallax effect
* `glowAlpha` - configure alpha of the glow effect (if is equal to 0.0 then the glow effect will be not added)
* `parallaxSubviewsContainer` - custom container view that will be usead to apply subviews parallax effect. By default it will be parallaxable view by itself.
* `glowContainerView` - view that will be used as the container for the glow effect. You don't have to configure this because for `ParallaxView` it will be automatically created a subview for this purpose, while for `ParallaxCollectionViewCell` it will be used `contentView` of the cell. Also by default it is nil when you use extension (`self` will be used as the glow container but only if `glowAlpha` is bigger than 0.0). But if you want to, you can define custom view - look into example project for more details.
* `glowImageView` - image view that will be used as the glow effect. `ParallaxView` framework provides default image that will be set.

Expand Down
8 changes: 5 additions & 3 deletions Sources/Other/ParallaxEffectOptions.swift
Expand Up @@ -19,7 +19,7 @@ public struct ParallaxEffectOptions {
public var shadowPanDeviation: Double = 0.0
/// Specify parallax effect of subiviews of the `parallaxEffectView`
public var subviewsParallaxMode = SubviewsParallaxMode.none
/// Custom view that will be used to apply subviews parallax mode effect
/// Custom container view that will be usead to apply subviews parallax effect
public var parallaxSubviewsContainer: UIView?
/// A view that will be a container for the glow effect
public weak var glowContainerView: UIView?
Expand All @@ -31,10 +31,12 @@ public struct ParallaxEffectOptions {
public var glowAlpha: Double = 1.0
/// Glow effect image view
public var glowImageView: UIImageView = ParallaxEffectOptions.defaultGlowImageView()

/// Constructor
///
/// - Parameter glowContainerView: Custom container view for the glow effect, if nil then it will be automatically configured
/// - Parameters:
/// - parallaxSubviewsContainer: Custom container view that will be usead to apply subviews parallax effect. By default it will be parallaxable view
/// - glowContainerView: Custom container view for the glow effect, if nil then it will be automatically configured
public init(parallaxSubviewsContainer: UIView? = nil, glowContainerView: UIView? = nil) {
self.parallaxSubviewsContainer = parallaxSubviewsContainer
self.glowContainerView = glowContainerView
Expand Down

0 comments on commit d3b1730

Please sign in to comment.