How quickbirdeng/xcoordinator works
Project type and purpose
• XCoordinator is not a full-stack app but a Swift package / iOS framework implementing the Coordinator pattern to decouple navigation logic from view controllers.
• It provides generic coordinator classes (e.g. NavigationCoordinator, TabBarCoordinator, PageCoordinator, SplitCoordinator, ViewCoordinator), router abstractions (StrongRouter, UnownedRouter, WeakRouter, AnyRouter), route enums, transition types, and animation utilities.
A. Core Module (Sources/XCoordinator)
– Protocols: Coordinator, Router, TransitionProtocol, Presentable
– Base classes: BaseCoordinator, BasicCoordinator, AnyCoordinator, Container
– Router abstractions: StrongRouter, UnownedErased, WeakErased, RedirectionRouter
– Coordinator types: NavigationCoordinator, TabBarCoordinator, PageCoordinator, SplitCoordinator, ViewCoordinator
– Route handling: Route (enum), Router.trigger(Route)
B. Transitions & Animations
– Transition, TransitionOptions, TransitionAnimation
– Animation classes: InteractiveTransitionAnimation, StaticTransitionAnimation, etc.
– UIKit extensions: UINavigationController+Transition, UITabBarController+Transition, UIViewController+Transition, UIPageViewController+Transition
C. Reactive Extensions
– RxSwift module (Sources/XCoordinatorRx/Router+Rx.swift)
– Combine module (Sources/XCoordinatorCombine/Router+Combine.swift)
D. Testing & Documentation
– Tests (in Tests/XCoordinatorTests), LinuxMain
– Generated docs (docs/) and jazzy config
E. Scripts & CI
– Build scripts (scripts/*.sh), Travis config, CocoaPods/Carthage/SPM files
1. Consumer App invokes
→ router.trigger(.someRoute)
→ calls into Router abstraction (Strong/Unowned/Any)
→ delegates to Coordinator.prepareTransition(for:)
→ returns a Transition
→ TransitionPerformer executes on the Coordinator’s rootViewController (e.g. UINavigationController)
→ causes UIKit to push, present, embed, etc.
2. Coordinators can nest: one coordinator’s transition can instantiate & present/push a child Coordinator (passing its rootViewController or creating a new one)
3. Transitions reference Animation objects when custom animations are needed
Architectural patterns & principles
• Coordinator pattern for navigation
• MVVM-C: ViewModels receive a Router abstraction to trigger navigation
• Protocol-oriented design: Core behavior defined by protocols, concrete types conform
• Type erasure: AnyRouter hides underlying generic coordinator types
• Dependency injection: rootViewController injected into coordinators, Router injected into ViewModels