https://github.com/ngochiencse/HPParallaxHeader

Simple parallax header for UIScrollView.
https://github.com/ngochiencse/HPParallaxHeader

Last synced: 10 days ago
JSON representation

Simple parallax header for UIScrollView.

• Host: GitHub
• URL: https://github.com/ngochiencse/HPParallaxHeader
• Owner: ngochiencse
• License: mit
• Created: 2021-03-04T15:36:32.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T11:21:30.000Z (4 months ago)
• Last Synced: 2024-10-20T00:45:34.711Z (20 days ago)
• Language: Swift
• Size: 8.13 MB
• Stars: 53
• Watchers: 3
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-swift - HPParallaxHeader - Simple parallax header for UIScrollView. (Libs / UI)
• awesome-swift - HPParallaxHeader - Simple parallax header for UIScrollView. (Libs / UI)

README

        
# HPParallaxHeader

[![Travis (.com)](https://img.shields.io/travis/com/ngochiencse/HPParallaxHeader)](https://www.travis-ci.com/github/ngochiencse/HPParallaxHeader)

[![Version](https://img.shields.io/cocoapods/v/HPParallaxHeader)](http://cocoapods.org/pods/HPParallaxHeader)

[![Swift 5.4](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fngochiencse%2FHPParallaxHeader%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/ngochiencse/HPParallaxHeader)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![License](https://img.shields.io/cocoapods/l/HPParallaxHeader)](http://cocoapods.org/pods/HPParallaxHeader)

[![Cocoapods platforms](https://img.shields.io/cocoapods/p/HPParallaxHeader)](http://cocoapods.org/pods/HPParallaxHeader)

HPParallaxHeader is a Swift conversion from https://github.com/maxep/MXParallaxHeader.

HPParallaxHeader is a simple header class for UIScrollView.

In addition, HPScrollView is a UIScrollView subclass with the ability to hook the vertical scroll from its subviews, this can be used to add a parallax header to complex view hierachy. Moreover, HPScrollViewController allows you to add a HPParallaxHeader to any kind of UIViewController.

|             UIScrollView        |           HPScrollViewController          |

|---------------------------------|-------------------------------------------|

|![Demo](Example/demo1.gif)|![Demo](Example/demo2.gif)|

## Usage

If you want to try it, simply run:

```

pod try HPParallaxHeader

```

+ Adding a parallax header to a UIScrollView is straightforward, e.g:

```swift

let headerView = UIImageView()

headerView.image = UIImage(named: "success-baby")

headerView.contentMode = .scaleAspectFit

let scrollView = UIScrollView()

scrollView.parallaxHeader.view = headerView

scrollView.parallaxHeader.height = 150

scrollView.parallaxHeader.mode = .fill

scrollView.parallaxHeader.minimumHeight = 20

```

+ The HPScrollViewController is a container with a child view controller that can be added programmatically or using the custom segue HPScrollViewControllerSegue.

## Installation

### Swift Package Manager 

You can use  [Swift Package Manager](https://swift.org/package-manager/)  directly within Xcode or add it to the `dependencies` value of your `Package.swift`.

```swift

dependencies: [

    .package(url: "https://github.com/ngochiencse/HPParallaxHeader", .upToNextMajor(from: "1.1.8"))

]

```

### CocoaPods

HPParallaxHeader is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile:

```ruby

pod "HPParallaxHeader"

```

## Documentation

Documentation is available through [GitHub](https://ngochiencse.github.io/HPParallaxHeader/documentation/hpparallaxheader).

## Author

[Hien Pham](https://github.com/ngochiencse)

![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fngochien91)

## License

HPParallaxHeader is available under the MIT license. See the LICENSE file for more info.