Close Menu

TransitionTreasury

Introduction

Welcome to the documentation for TransitionTreasury! This library provides a collection of custom transition animations for iOS apps, making your user interfaces more engaging and visually appealing.

Installation

To install TransitionTreasury, you have a few options:

Cocoapods

1. Add the following line to your Podfile:


pod 'TransitionTreasury'

2. Run pod install command to install the library.

Carthage

1. Add the following line to your Cartfile:


github "andreamazz/TransitionTreasury"

2. Run carthage update command to compile the framework.

Manual Installation

If you prefer, you can also install TransitionTreasury manually. Just follow these steps:

  • Download the latest release from the GitHub repository.
  • Drag and drop the TransitionTreasury.swift file into your Xcode project.
  • Make sure the file is added to the appropriate target.

Usage

To use TransitionTreasury in your app, follow these steps:

Step 1: Import

In the file where you want to use the library, import TransitionTreasury:


import TransitionTreasury

Step 2: Implement Protocol

In the view controller that presents or dismisses another view controller using a transition animation, implement the ViewTransitionable protocol:


class MyViewController: UIViewController, ViewTransitionable {

Step 3: Set up TransitionConfig

Define a TransitionConfig object to specify the desired transition animation and configuration:


let transitions = TransitionConfig(type: .fade, present: MyPresentAnimation(), dismiss: MyDismissAnimation())

Note: You’ll need to create your own custom animation classes.

Step 4: Present or Dismiss

Use the transitionTo() and transitionBack() methods to present or dismiss the desired view controller:


transitionTo(MyOtherViewController(), completion: nil)

Examples and Additional Information

  • Visit the GitHub repository for more examples and detailed documentation.
  • Check out the official TransitionStudy project for comprehensive examples and tutorials.

Conclusion

Congratulations! You now have the necessary information to integrate TransitionTreasury into your iOS app. Enhance your user experience by using beautiful custom transition animations and make your app stand out.