diff --git a/docs/UsageGuide.md b/docs/UsageGuide.md deleted file mode 100644 index 1461fd3c..00000000 --- a/docs/UsageGuide.md +++ /dev/null @@ -1,60 +0,0 @@ -# Usage - -## Storyboard - -1. In the Identity Inspector, for every pair of source/destination views, give each one the same `HeroID` attribute. -2. For any other views that you would like to animate, specify animation effects in the `Hero Modifier String` attribute. -3. Also in the Identity Inspector, enable Hero Transition on your destination view controller. - -## In Code - -1. Before doing a transition, set the desired `heroID` and `heroModifiers` to both your source and destination views. -2. Enable Hero for the destination view controller - - ```swift - viewController.hero.isEnabled = true - ``` - -### UINavigationController & UITabBarController - -Hero also supports transitions within a navigation controller or a tab bar controller—just set the 'hero.isEnabled' attribute to true on the UINavigationController/UITabBarController instance. - -## Attributes - -There are two important attributes to understand: `heroID` and `heroModifiers`. These are implemented as extensions (using associated objects) for `UIView`. Therefore, after the Hero library is imported, every `UIView` will have these two attributes. - -| Attribute Name | Description | -| --- | --- | -| `heroID` | Identifier for the view. Hero will automatically transition between views with the same `heroID` | -| `hero.modifiers` | Specifies the extra animations performed alongside the main transition. | - -## HeroID - -`heroID` is the identifier for the view. When doing a transition between two view controllers, Hero will search through all subviews for both controllers, and match any views with the same `heroID`. Whenever a pair is discovered, Hero will automatically transit the views from source state to destination state. - -## HeroModifiers - -Use `hero.modifiers` to specify animations alongside the main transition. Checkout [HeroModifier.swift](https://github.com/lkzhao/Hero/blob/master/Sources/HeroModifier.swift) for available modifiers. - -#### For example, to achieve the following effect, set the `hero.modifiers` to be - -```swift -view.hero.modifiers = [.fade, .translate(x:0, y:-250), .rotate(x:-1.6), .scale(1.5)] -``` - - - - -Note: For matched views, the target view's heroModifier will be used. The source view's heroModifier will be ignored. When dismissing, the target view is the presentingViewController's view and the source view is the presentedViewController's view. - -## HeroModifierString - -This is a string value. It provides another way to set `hero.modifiers`. It can be accessed through the storyboard. - -It must be in the following syntax: - -```swift -modifier1() modifier2(parameter1) modifier3(parameter1, parameter2) ... -``` - -Parameters must be between a pair of parentheses, separated by a comma, and each modifier must be separated by a space. Not all modifiers are settable this way.