Update readme.

Example/SwiftUICoordinatorExample/SwiftUICoordinatorExample/Transitions/FadeTransition.swift

@@ -10,8 +10,7 @@ import SwiftUICoordinator
 
 class FadeTransition: NSObject, Transition {
  func isEligible(from fromRoute: NavigationRoute, to toRoute: NavigationRoute) -> Bool {
- return (fromRoute as? CustomShapesRoute == .customShapes && toRoute as? CustomShapesRoute == .star) ||
- (fromRoute as? CustomShapesRoute == .customShapes && toRoute as? CustomShapesRoute == .tower)
+ return (fromRoute as? CustomShapesRoute == .customShapes && toRoute as? CustomShapesRoute == .star)
  }
 
  func transitionDuration(using transitionContext: UIViewControllerContextTransitioning?) -> TimeInterval {

README.md

@@ -51,9 +51,9 @@ This protocol defines the available routes for navigation within a coordinator f
 public protocol NavigationRoute {
  /// This title can be used to set the navigation bar title when the route is shown.
  var title: String? { get }
- /// The type of transition to be used when the route is shown. 
- /// This can be a push transition, a modal presentation, or `nil` (for child coordinators).
- var transition: NavigationTransition? { get }
+ /// Transition action to be used when the route is shown.
+ /// This can be a push action, a modal presentation, or `nil` (for child coordinators).
+ var action: TransitionAction? { get }
 }
 ```
 
@@ -78,7 +78,7 @@ public protocol Navigator: ObservableObject {
  /// This method is called when the navigator should start navigating.
  func start() throws
  /// Navigate to a specific route. 
- /// It creates a view for the route and adds it to the navigation stack using the specified transition.
+ /// It creates a view for the route and adds it to the navigation stack using the specified action (TransitionAction).
  func show(route: Route) throws
  /// Sets the navigation stack to a new array of routes.
  /// It can be useful if you need to reset the entire navigation stack to a new set of views.
@@ -140,7 +140,7 @@ enum ShapesRoute: NavigationRoute {
  }
  }
 
- var transition: NavigationTransition? {
+ var action: TransitionAction? {
  switch self {
  case .simpleShapes:
  // We have to pass nil for the route presenting a child coordinator.
@@ -293,6 +293,52 @@ struct ShapesView<Coordinator: Routing>: View {
 }
 ```
 
+### Custom transitions
+
+Create custom transition.
+
+```Swift
+class FadeTransition: NSObject, Transition {
+ func isEligible(from fromRoute: NavigationRoute, to toRoute: NavigationRoute) -> Bool {
+ return (fromRoute as? CustomShapesRoute == .customShapes && toRoute as? CustomShapesRoute == .star)
+ }
+
+ func transitionDuration(using transitionContext: UIViewControllerContextTransitioning?) -> TimeInterval {
+ return 0.3 // Set the duration of the fade animation
+ }
+
+ func animateTransition(using transitionContext: UIViewControllerContextTransitioning) {
+ guard let toView = transitionContext.view(forKey: .to) else {
+ transitionContext.completeTransition(false)
+ return
+ }
+
+ let containerView = transitionContext.containerView
+ toView.alpha = 0.0
+
+ containerView.addSubview(toView)
+
+ UIView.animate(withDuration: transitionDuration(using: transitionContext), animations: {
+ toView.alpha = 1.0
+ }) { _ in
+ transitionContext.completeTransition(!transitionContext.transitionWasCancelled)
+ }
+ }
+}
+```
+
+Register transition in the coordinator initializer.
+
+```Swift
+ init(startRoute: ShapesRoute? = nil) {
+ self.navigationController = NavigationController()
+ self.startRoute = startRoute
+ super.init()
+
+ navigationController.register(FadeTransition())
+ }
+```
+
 ## 📒 Example project
 
 For better understanding, I recommend that you take a look at the example project located in the `SwiftUICoordinatorExample` folder.