Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/HarshilShah/DeckTransition

A library to recreate the iOS Apple Music now playing transition
https://github.com/HarshilShah/DeckTransition

apple-music ios modals transition

Last synced: 3 months ago
JSON representation

A library to recreate the iOS Apple Music now playing transition

Host: GitHub
URL: https://github.com/HarshilShah/DeckTransition
Owner: HarshilShah
License: mit
Created: 2016-10-18T16:37:55.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2022-05-17T16:17:11.000Z (over 2 years ago)
Last Synced: 2024-07-20T16:21:02.942Z (4 months ago)
Topics: apple-music, ios, modals, transition
Language: Swift
Homepage:
Size: 2.47 MB
Stars: 2,190
Watchers: 34
Forks: 168
Open Issues: 23
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-ios - DeckTransition - A library to recreate the iOS Apple Music now playing transition. (UI / Transition)
awesome-swift - DeckTransition - A library to recreate the iOS 10 Apple Music now playing transition. (Libs / UI)
awesome-swift - DeckTransition - A library to recreate the iOS 10 Apple Music now playing transition. (Libs / UI)
awesome-ios-star - DeckTransition - A library to recreate the iOS Apple Music now playing transition. (UI / Transition)
fucking-awesome-swift - DeckTransition - A library to recreate the iOS 10 Apple Music now playing transition. (Libs / UI)
awesome-swift - DeckTransition - A library to recreate the iOS Apple Music now playing transition ` 📝 2 years ago ` (UI [🔝](#readme))

README

        # DeckTransition

[![CI Status](http://img.shields.io/travis/HarshilShah/DeckTransition.svg)](https://travis-ci.org/HarshilShah/DeckTransition)

[![Version](https://img.shields.io/github/release/HarshilShah/DeckTransition.svg)](https://github.com/HarshilShah/DeckTransition/releases/latest)

![Package Managers](https://img.shields.io/badge/supports-CocoaPods%20%7C%20Carthage-orange.svg)

[![Documentation](https://cdn.rawgit.com/HarshilShah/DeckTransition/master/docs/badge.svg)](https://harshilshah.github.com/DeckTransition)

[![License](https://img.shields.io/badge/license-MIT-999999.svg)](https://github.com/HarshilShah/DeckTransition/blob/master/LICENSE)

[![Contact](https://img.shields.io/badge/contact-%40HarshilShah1910-3a8fc1.svg)](https://twitter.com/HarshilShah1910)

DeckTransition is an attempt to recreate the card-like transition found in the iOS 10 Apple Music and iMessage apps.

Hereʼs a GIF showing it in action.

![Demo](https://raw.githubusercontent.com/HarshilShah/DeckTransition/master/Resources/demo.gif)

## Requirements

- Swift 5.0

- iOS 9 or later

## Installation

### CocoaPods

To install DeckTransition using [CocoaPods](http://cocoapods.org), add the following line to your Podfile:

```

pod 'DeckTransition', '~> 2.0'

```

### Carthage

To install DeckTransition using [Carthage](https://github.com/Carthage/Carthage), add the following line to your Cartfile:

```

github "HarshilShah/DeckTransition" ~> 2.0

```

## Documentation

You can find [the docs here](https://harshilshah.github.io/DeckTransition "Documentation"). Documentation is generated with [Jazzy](https://github.com/realm/jazzy), and hosted on [GitHub Pages](https://pages.github.com).

## Usage

### Basics

Set `modalPresentationCapturesStatusBarAppearance` to `true` in your modal view controller, and override the `preferredStatusBarStyle` variable to return `.lightContent`.

Additionally, the `UIScrollView` instances which should be tracked for the swipe-to-dismiss gesture should have their `backgroundColor` set to `.clear`.

### Presentation

The transition can be called from code or using a storyboard.

To use via storyboards, just setup a custom segue (`kind` set to `custom`), and set the `class` to `DeckSegue`.

Hereʼs a snippet showing usage via code. Just replace `ModalViewController()` with your view controller's class and youʼre good to go.

```swift

let modal = ModalViewController()

let transitionDelegate = DeckTransitioningDelegate()

modal.transitioningDelegate = transitionDelegate

modal.modalPresentationStyle = .custom

present(modal, animated: true, completion: nil)

```

### Dismissal

By default, DeckTransition has a swipe-to-dismiss gesture which is automatically enabled when your modalʼs main `UIScrollView` is scrolled to the top.

You can opt-out of this behaviour by passing in `false` for the `isSwipeToDismissEnabled` parameter while initialising your `DeckTransitioningDelegate`.

### `UIScrollView` detection

DeckTransition has an internal heuristic to determine which `UIScrollView` should be tracked for the swipe-to-dismiss gesture. In general, this should be sufficient for and cover most use cases.

However there are some edge cases, and should you run into one, these can we worked around by making your modal view controller conform to the `DeckTransitionViewControllerProtocol` protocol. More information about this can be found in the documentation page about [UIScrollView detection](https://harshilshah.github.io/DeckTransition/uiscrollview-detection.html).

### Snapshots

For a variety of reasons, and especially because of iOS 11's safe area layout, DeckTransition uses a snapshot of your presenting view controller's view instead of using the view directly. This view is automatically updated whenever the frame is resized.

However, there can be some cases where you might want to update the snapshot view by yourself, and this can be achieved using the following one line snippet:

```swift

(presentationController as? DeckSnapshotUpdater)?.requestPresentedViewSnapshotUpdate()

```

All this does is request the presentation controller to update the snapshot.

You can also choose to update snapshot directly from the presenting view controller, as follows:

```swift

(presentedViewController?.presentationController as? DeckSnapshotUpdater)?.requestPresentedViewSnapshotUpdate()

```

It's worth noting that updating the snapshot is an expensive process and should only be used if necessary, for example if you are updating your entire app's theme.

## Apps Using DeckTransition

- [Petty](https://zachsim.one/projects/petty) by [Zach Simone](https://twitter.com/zachsimone)

- [Bitbook](https://bitbookapp.com) by [Sammy Gutierrez](https://sammygutierrez.com)

- [What's Open for iOS](https://git.gmu.edu/srct/whats-open-ios) by [Mason SRCT](https://srct.gmu.edu/)

- [Manabi Reader](https://reader.manabi.io) by [Alex Ehlke](https://twitter.com/aehlke)

Feel free to submit a PR if you’re using this library in your apps

## Author

Written by [Harshil Shah](https://twitter.com/HarshilShah1910)

## License

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