# quickbirdeng/xcoordinator architecture

> Architecture diagram of the GitHub repository quickbirdeng/xcoordinator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/quickbirdeng/xcoordinator
- Repository: https://github.com/quickbirdeng/xcoordinator

## Overview

##### 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

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Dependencies
    subgraph "External Dependencies"
        PackageManagers[(Package Managers)]:::external
        UIKit[(UIKit)]:::external
        ConsumerApp[/Consumer App/]:::external
    end

    %% Core Module
    subgraph "Core Module"
        direction TB
        CoreProtocols["Protocols"]:::core
        CoordinatorProt["Coordinator"]:::core
        RouterProt["Router"]:::core
        TransitionProt["TransitionProtocol"]:::core
        PresentableProt["Presentable"]:::core

        BaseCoordinator["BaseCoordinator"]:::core
        BasicCoordinator["BasicCoordinator"]:::core
        AnyCoordinator["AnyCoordinator"]:::core
        Container["Container"]:::core

        StrongRouter["StrongRouter"]:::core
        UnownedErased["UnownedErased"]:::core
        UnownedRouterExt["+Router"]:::core
        WeakErased["WeakErased"]:::core
        WeakRouterExt["+Router"]:::core
        RedirectionRouter["RedirectionRouter"]:::core

        NavigationCoordinator["NavigationCoordinator"]:::core
        TabBarCoordinator["TabBarCoordinator"]:::core
        PageCoordinator["PageCoordinator"]:::core
        SplitCoordinator["SplitCoordinator"]:::core
        ViewCoordinator["ViewCoordinator"]:::core

        RouteEnum["Route (enum)"]:::core
        TransitionStruct["Transition"]:::core
    end

    %% Transitions & Animations
    subgraph "Transitions & Animations"
        direction TB
        TransitionOptions["TransitionOptions"]:::ui
        TransitionAnimationProt["TransitionAnimation"]:::ui
        InteractiveAnim["InteractiveTransitionAnimation"]:::ui
        InterruptibleAnim["InterruptibleTransitionAnimation"]:::ui
        StaticAnim["StaticTransitionAnimation"]:::ui
        subgraph "UIKit Extensions"
            UINavigationExt["UINavigationController+Transition"]:::ui
            UITabBarExt["UITabBarController+Transition"]:::ui
            UIViewControllerExt["UIViewController+Transition"]:::ui
            UIPageViewExt["UIPageViewController+Transition"]:::ui
        end
    end

    %% Reactive Extensions
    subgraph "Reactive Extensions"
        direction TB
        RxExt["Router+Rx"]:::reactive
        CombineExt["Router+Combine"]:::reactive
    end

    %% Tools & CI
    subgraph "Tools & CI"
        direction TB
        Tests["Tests"]:::tool
        Docs["Docs"]:::tool
        Scripts["Scripts"]:::tool
        CiConfig[".travis.yml"]:::tool
    end

    %% Connections
    ConsumerApp -->|"trigger(route)"| RouterProt
    RouterProt -->|"implemented by"| StrongRouter
    StrongRouter -->|"delegate to"| BaseCoordinator
    BaseCoordinator -->|"prepareTransition"| TransitionStruct
    TransitionStruct -->|"perform(push/present)"| UIKit
    TransitionStruct -->|"uses animation"| TransitionAnimationProt
    TransitionAnimationProt --> InteractiveAnim
    TransitionAnimationProt --> InterruptibleAnim
    TransitionAnimationProt --> StaticAnim

    BaseCoordinator --> NavigationCoordinator
    BaseCoordinator --> TabBarCoordinator
    BaseCoordinator --> PageCoordinator
    BaseCoordinator --> SplitCoordinator
    BaseCoordinator --> ViewCoordinator

    CoreModuleToRx(CoreProtocols) --> RxExt
    CoreModuleToCombine(CoreProtocols) --> CombineExt

    PackageManagers --> ConsumerApp
    Scripts --> PackageManagers
    Scripts --> Docs
    Scripts --> Tests
    CiConfig --> Scripts

    %% Click Events
    click CoordinatorProt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/Coordinator.swift"
    click RouterProt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/Router.swift"
    click TransitionProt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/TransitionProtocol.swift"
    click PresentableProt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/Presentable.swift"
    click BaseCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/BaseCoordinator.swift"
    click BasicCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/BasicCoordinator.swift"
    click AnyCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/AnyCoordinator.swift"
    click Container "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/Container.swift"
    click StrongRouter "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/StrongRouter.swift"
    click UnownedErased "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/UnownedErased.swift"
    click UnownedRouterExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/UnownedErased+Router.swift"
    click WeakErased "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/WeakErased.swift"
    click WeakRouterExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/WeakErased+Router.swift"
    click RedirectionRouter "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/RedirectionRouter.swift"
    click NavigationCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/NavigationCoordinator.swift"
    click TabBarCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/TabBarCoordinator.swift"
    click PageCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/PageCoordinator.swift"
    click SplitCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/SplitCoordinator.swift"
    click ViewCoordinator "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/ViewCoordinator.swift"
    click RouteEnum "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/Route.swift"
    click TransitionStruct "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/Transition.swift"
    click TransitionOptions "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/TransitionOptions.swift"
    click TransitionAnimationProt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/TransitionAnimation.swift"
    click InteractiveAnim "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/InteractiveTransitionAnimation.swift"
    click InterruptibleAnim "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/InterruptibleTransitionAnimation.swift"
    click StaticAnim "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/StaticTransitionAnimation.swift"
    click UINavigationExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/UINavigationController+Transition.swift"
    click UITabBarExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/UITabBarController+Transition.swift"
    click UIViewControllerExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/UIViewController+Transition.swift"
    click UIPageViewExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinator/UIPageViewController+Transition.swift"
    click RxExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinatorRx/Router+Rx.swift"
    click CombineExt "https://github.com/quickbirdeng/xcoordinator/blob/master/Sources/XCoordinatorCombine/Router+Combine.swift"
    click Tests "https://github.com/quickbirdeng/xcoordinator/tree/master/Tests/XCoordinatorTests"
    click Docs "https://github.com/quickbirdeng/xcoordinator/tree/master/docs/"
    click Scripts "https://github.com/quickbirdeng/xcoordinator/tree/master/scripts/"
    click CiConfig "https://github.com/quickbirdeng/xcoordinator/blob/master/.travis.yml"
    click PackageManagers "https://github.com/quickbirdeng/xcoordinator/blob/master/Package.swift"

    %% Styles
    classDef core fill:#D0E6FF,stroke:#0366d6,color:#0366d6;
    classDef reactive fill:#E6FFE6,stroke:#28a745,color:#22863a;
    classDef ui fill:#FFE6CC,stroke:#d18614,color:#d18614;
    classDef tool fill:#F0F0F0,stroke:#6a737d,color:#586069;
    classDef external fill:#FFF5CC,stroke:#dbab09,color:#735c0f;
```
