# zumerlab/orbit architecture

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

- Interactive diagram: https://gitdiagram.com/zumerlab/orbit
- Repository: https://github.com/zumerlab/orbit

## Overview

##### Main Components

a) Core Framework Components:
- SCSS Module System
- JavaScript Utilities
- Public API (CSS Classes)

b) Key Architectural Elements:
- Style Processing Pipeline
- Layout Engine
- Theme System
- Utility Functions

**┌─ Public Interface Layer ─────────────────┐**
- CSS Classes (.bigbang, .orbit, etc.)   │
- Theme System                           │
- ┘

**┌─ Core Processing Layer ──────────────────┐**
- ┌─ SCSS Modules ─┐  ┌─ JS Utilities ─┐  │
- Layout       │  │ - Orbit Arc    │  │
- Components   │  │ - Progress     │  │
- Themes       │  │ - Resize       │  │
- ┘  └───────────────────┘ │
- ┘

**┌─ Foundation Layer ────────────────────────┐**
- Variables                               │
- Support Functions                       │
- Utility Classes                         │
- ┘

##### Component Relationships

- How SCSS modules compile into the public CSS classes
- How JavaScript utilities interact with the DOM
- How themes affect the entire system
- How utility functions support both SCSS and JS components

##### Implementation Details

For each major component, add annotations showing:
- File location (from the file tree)
- Primary responsibilities
- Dependencies on other components

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Public Interface Layer"
        PublicCSS["CSS Classes (.bigbang, .orbit)"]:::public
        ThemeSystem["Theme System"]:::public
    end

    subgraph "Core Processing Layer"
        subgraph "SCSS Modules"
            LayoutEngine["Layout Engine"]:::scss
            CoreComponents["Core Components"]:::scss
            ArcSystem["Arc System"]:::scss
            VectorSystem["Vector System"]:::scss
            SidePos["Side Positioning"]:::scss
            TextHandling["Text Handling"]:::scss
        end

        subgraph "JavaScript Utilities"
            OrbitArc["Orbit Arc"]:::js
            OrbitProgress["Progress Handler"]:::js
            OrbitResize["Resize Handler"]:::js
        end
    end

    subgraph "Foundation Layer"
        Variables["Variables"]:::foundation
        SupportFuncs["Support Functions"]:::foundation
        Utils["Utilities"]:::foundation
    end

    %% Relationships
    Variables --> LayoutEngine
    Variables --> CoreComponents
    SupportFuncs --> LayoutEngine
    Utils --> CoreComponents

    LayoutEngine --> PublicCSS
    CoreComponents --> PublicCSS
    ArcSystem --> PublicCSS
    VectorSystem --> PublicCSS
    SidePos --> PublicCSS
    TextHandling --> PublicCSS

    ThemeSystem --> PublicCSS
    ThemeSystem --> CoreComponents

    OrbitArc --> PublicCSS
    OrbitProgress --> PublicCSS
    OrbitResize --> PublicCSS

    %% Click Events
    click PublicCSS "https://github.com/zumerlab/orbit/blob/main/src/scss/_orbit-class.scss"
    click ThemeSystem "https://github.com/zumerlab/orbit/blob/main/src/scss/_themes.scss"
    click OrbitArc "https://github.com/zumerlab/orbit/blob/main/src/js/orbit-arc.js"
    click OrbitProgress "https://github.com/zumerlab/orbit/blob/main/src/js/orbit-progress.js"
    click OrbitResize "https://github.com/zumerlab/orbit/blob/main/src/js/orbit-resize.js"
    click LayoutEngine "https://github.com/zumerlab/orbit/blob/main/src/scss/_radial-layout.scss"
    click CoreComponents "https://github.com/zumerlab/orbit/blob/main/src/scss/_bigbang.scss"
    click Variables "https://github.com/zumerlab/orbit/blob/main/src/scss/_variables.scss"
    click SupportFuncs "https://github.com/zumerlab/orbit/blob/main/src/scss/_support.scss"
    click Utils "https://github.com/zumerlab/orbit/blob/main/src/scss/_utilities.scss"
    click ArcSystem "https://github.com/zumerlab/orbit/blob/main/src/scss/_arc.scss"
    click VectorSystem "https://github.com/zumerlab/orbit/blob/main/src/scss/_vector.scss"
    click SidePos "https://github.com/zumerlab/orbit/blob/main/src/scss/_side.scss"
    click TextHandling "https://github.com/zumerlab/orbit/blob/main/src/scss/_text.scss"

    %% Styles
    classDef public fill:#4a90e2,stroke:#2c3e50,color:white
    classDef scss fill:#2ecc71,stroke:#27ae60,color:white
    classDef js fill:#e67e22,stroke:#d35400,color:white
    classDef foundation fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Legend
    subgraph Legend
        L1["Public Interface"]:::public
        L2["SCSS Module"]:::scss
        L3["JavaScript Utility"]:::js
        L4["Foundation Component"]:::foundation
    end
```
