# kaunteya/progresskit architecture

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

- Interactive diagram: https://gitdiagram.com/kaunteya/progresskit
- Repository: https://github.com/kaunteya/progresskit

## Overview

##### Main Components

a. Core Framework Layer:
- BaseView (foundation class)
- ProgressUtils (shared utilities)

b. Two Main Progress Types:
1. Determinate Progress Components:
- CircularProgressView
- ProgressBar
- DeterminateAnimation

2. Indeterminate Progress Components:
- MaterialProgress
- Rainbow
- Crawler
- Spinner
- ShootingStars
- RotatingArc
- IndeterminateAnimation

c. Integration Layer:
- CocoaPods integration
- Interface Builder support (IBDesignable)

##### Specific Elements

**┌─────────────────────────────────────────────────────┐**
- Client Application                    │
- ┘
- ↑
**┌─────────────────────────────────────────────────────┐**
- CocoaPods Integration                  │
- ┘
- ↑
**┌─────────────────────────────────────────────────────┐**
- ProgressKit                        │
- ┌───────────────┐        ┌────────────────┐        │
- Determinate  │        │  Indeterminate │        │
- Components   │        │   Components   │        │
- ┘        └────────────────┘        │
- ↑                        ↑                  │
- ┌───────────────────────────────────────────┐      │
- BaseView                     │      │
- ┘      │
- ┘

##### Important Details to Highlight

- IBDesignable support for all progress components
- Animation control flow
- Public interfaces and customization points
- Relationship with Interface Builder
- Progress value flow for determinate components

##### Implementation Notes

- Notes about IBDesignable integration

##### Integration Points

- How the library integrates with CocoaPods
- Storyboard/XIB integration points
- Public APIs and interfaces

Remember to include a note about the Swift version compatibility and iOS platform requirements, as these are critical for implementation considerations.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client["Client Application Layer"]
        App["iOS Application"]
        IB["Interface Builder"]
        click IB "https://github.com/kaunteya/ProgressKit/blob/master/ProgressKit/Base.lproj/Main.storyboard"
    end

    subgraph Integration["Integration Layer"]
        Cocoa["CocoaPods Integration"]
        click Cocoa "https://github.com/kaunteya/ProgressKit/blob/master/ProgressKit.podspec"
    end

    subgraph Progress["ProgressKit Framework"]
        subgraph Core["Core Components"]
            Base["BaseView"]
            Utils["ProgressUtils"]
            click Base "https://github.com/kaunteya/ProgressKit/blob/master/BaseView.swift"
            click Utils "https://github.com/kaunteya/ProgressKit/blob/master/ProgressUtils.swift"
        end

        subgraph Det["Determinate Progress"]
            DVC["Determinate View Controller"]
            CircularView["CircularProgressView"]
            ProgressBar["ProgressBar"]
            DetAnim["DeterminateAnimation"]
            
            click DVC "https://github.com/kaunteya/ProgressKit/blob/master/ProgressKit/DeterminateVC.swift"
            click CircularView "https://github.com/kaunteya/ProgressKit/blob/master/Determinate/CircularProgressView.swift"
            click ProgressBar "https://github.com/kaunteya/ProgressKit/blob/master/Determinate/ProgressBar.swift"
            click DetAnim "https://github.com/kaunteya/ProgressKit/blob/master/Determinate/DeterminateAnimation.swift"
        end

        subgraph Indet["Indeterminate Progress"]
            IDVC["Indeterminate View Controller"]
            Material["MaterialProgress"]
            Rainbow["Rainbow"]
            Crawler["Crawler"]
            Spinner["Spinner"]
            Stars["ShootingStars"]
            Arc["RotatingArc"]
            IndetAnim["IndeterminateAnimation"]
            
            click IDVC "https://github.com/kaunteya/ProgressKit/blob/master/ProgressKit/InDeterminateVC.swift"
            click Material "https://github.com/kaunteya/ProgressKit/blob/master/InDeterminate/MaterialProgress.swift"
            click Rainbow "https://github.com/kaunteya/ProgressKit/blob/master/InDeterminate/Rainbow.swift"
            click Crawler "https://github.com/kaunteya/ProgressKit/blob/master/InDeterminate/Crawler.swift"
            click Spinner "https://github.com/kaunteya/ProgressKit/blob/master/InDeterminate/Spinner.swift"
            click Stars "https://github.com/kaunteya/ProgressKit/blob/master/InDeterminate/ShootingStars.swift"
            click Arc "https://github.com/kaunteya/ProgressKit/blob/master/InDeterminate/RotatingArc.swift"
            click IndetAnim "https://github.com/kaunteya/ProgressKit/blob/master/InDeterminate/IndeterminateAnimation.swift"
        end
    end

    %% Relationships
    App --> IB
    App --> Cocoa
    Cocoa --> Progress
    IB --> Progress

    %% Core Relationships
    Base --> CircularView
    Base --> ProgressBar
    Base --> Material
    Base --> Rainbow
    Base --> Crawler
    Base --> Spinner
    Base --> Stars
    Base --> Arc

    Utils --> DetAnim
    Utils --> IndetAnim

    %% Controller Relationships
    DVC --> CircularView
    DVC --> ProgressBar
    IDVC --> Material
    IDVC --> Rainbow
    IDVC --> Crawler
    IDVC --> Spinner
    IDVC --> Stars
    IDVC --> Arc

    %% Animation Relationships
    DetAnim --> CircularView
    DetAnim --> ProgressBar
    IndetAnim --> Material
    IndetAnim --> Rainbow
    IndetAnim --> Crawler
    IndetAnim --> Spinner
    IndetAnim --> Stars
    IndetAnim --> Arc

    %% Styling
    classDef default fill:#f9f9f9,stroke:#333,stroke-width:1px
    classDef core fill:#b3e0ff,stroke:#333,stroke-width:1px
    classDef determinate fill:#b3ffb3,stroke:#333,stroke-width:1px
    classDef indeterminate fill:#ffcc99,stroke:#333,stroke-width:1px
    classDef integration fill:#e6e6e6,stroke:#333,stroke-width:1px

    class Base,Utils core
    class CircularView,ProgressBar,DetAnim,DVC determinate
    class Material,Rainbow,Crawler,Spinner,Stars,Arc,IndetAnim,IDVC indeterminate
    class Cocoa,IB,App integration
```
