Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/digipolitan/parallax-view-controller-transition


https://github.com/digipolitan/parallax-view-controller-transition

carthage cocoapod cocoapods fastlane ios parallax swift swift-package-manager tvos view-controller

Last synced: about 23 hours ago
JSON representation

Awesome Lists containing this project

README

        

DGParallaxViewControllerTransition
=================================

[![Build Status](https://travis-ci.org/Digipolitan/parallax-view-controller-transition.svg?branch=master)](https://travis-ci.org/Digipolitan/parallax-view-controller-transition)
[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/DGParallaxViewControllerTransition.svg)](https://img.shields.io/cocoapods/v/DGParallaxViewControllerTransition.svg)
[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Platform](https://img.shields.io/cocoapods/p/DGParallaxViewControllerTransition.svg?style=flat)](http://cocoadocs.org/docsets/DGParallaxViewControllerTransition)
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](http://twitter.com/Digipolitan)

The `ParallaxInteractiveTransition` add a simple way to perform parallax interactive transition between 2 UIViewController

### Demo iOS

![Demo iOS](https://github.com/Digipolitan/parallax-view-controller-transition/blob/develop/Screenshots/ios_capture.gif?raw=true "Demo iOS")

### Demo tvOS

![Demo tvOS](https://github.com/Digipolitan/parallax-view-controller-transition/blob/develop/Screenshots/tvos_capture.gif?raw=true "Demo tvOS")

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

Works with iOS 8+, tested on Xcode 9.2

### Installing

To install the `DGParallaxViewControllerTransition` using **cocoapods**

- Add an entry in your Podfile

```
# Uncomment this line to define a global platform for your project
platform :ios, '8.0'

target 'YourTarget' do
frameworks
use_frameworks!

# Pods for YourTarget
pod 'DGParallaxViewControllerTransition'
end
```

- Then install the dependency with the `pod install` command.

## Usage

How to perform the transition

```swift
let viewController = UIViewController()
let parallaxTransition = DGParallaxViewControllerTransition()
parallaxTransition.attach(to: viewController)
self.present(viewController, animated: true, completion: nil)
self.parallaxTransition = parallaxTransition // You must retain the parallax transition
```

### Configuration

You can customize the component with these options:

```swift
let viewController = UIViewController()
let parallaxTransition = DGParallaxViewControllerTransition()
parallaxTransition.presentedViewInsets = UIEdgeInsets(top: 100, left: 0, bottom: 0, right: 0)
parallaxTransition.overlayColor = .gray
parallaxTransition.maximumOverlayAlpha = 0.5
parallaxTransition.attach(to: viewController)
self.present(viewController, animated: true, completion: nil)
self.parallaxTransition = parallaxTransition // You must retain the parallax transition
```

## Built With

[Fastlane](https://fastlane.tools/)
Fastlane is a tool for iOS, Mac, and Android developers to automate tedious tasks like generating screenshots, dealing with provisioning profiles, and releasing your application.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!

This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report
unacceptable behavior to [[email protected]](mailto:[email protected]).

## License

DGParallaxViewControllerTransition is licensed under the [BSD 3-Clause license](LICENSE).