# ranga-auaha-ako/canvas-design-blocks architecture

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

- Interactive diagram: https://gitdiagram.com/ranga-auaha-ako/canvas-design-blocks
- Repository: https://github.com/ranga-auaha-ako/canvas-design-blocks

## Overview

##### Main System Components

a. Core Components:
- Element System (src/lib/elements/)
- Toolbar Interface (src/lib/toolbar/)
- Theme Management (src/theme-loader.ts)
- Canvas Integration Layer

b. Element Types:
- MCE Elements
- Svelte Elements
- Client-Enabled Elements
- Generic Element Base Classes

##### Architectural Patterns to Emphasize

- Manager-Element Pattern (Each element type has a manager class)
- Component Composition (Svelte components hierarchy)
- Event-driven Communication (Between Canvas, TinyMCE, and elements)

**┌─ Canvas LMS Integration Layer ─────────────────────┐**

- ┌─ Design Blocks Core ──────────────────────┐     │

- ┌─ Element System ─┐  ┌─ Toolbar ─┐      │     │

- Base Classes  │  │ - Panel   │      │     │
- Managers      │  │ - Search  │      │     │
- Elements      │  │ - Config  │      │     │
- ┘  └───────────┘      │     │

- Loader      │   │  - Builder    │   │     │
- Config      │   │  - Registry   │   │     │
- ┘   └───────────────┘   │     │

- ┘     │

- ┘

##### Key Relationships

- Data flow between Canvas and Design Blocks
- Element manager to element instances
- Theme system influence on all components
- Toolbar interactions with elements

##### Additional Details

Annotations for:
- Build/Deploy Pipeline
- Theme Configuration Flow
- Element Lifecycle
- User Interaction Points
- Integration Points with TinyMCE

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Canvas["Canvas LMS Integration Layer"]
        CanvasTypes["Type Definitions"]
        CourseEnv["Course Environment"]
        TinyMCE["TinyMCE Integration"]
    end

    subgraph Core["Design Blocks Core"]
        subgraph Elements["Element System"]
            BaseClasses["Base Classes"]
            MCE["MCE Elements"]
            Svelte["Svelte Elements"]
            ClientEnabled["Client-Enabled Elements"]
            ElementManager["Element Manager"]
        end

        subgraph Toolbar["Toolbar Interface"]
            Panel["Element Panel"]
            Search["Element Search"]
            Tooltip["Element Tooltip"]
        end

        subgraph Theme["Theme System"]
            ThemeLoader["Theme Loader"]
            ThemeUtils["Theme Utilities"]
            ElementTheme["Element Theme"]
        end

        subgraph Icons["Icon System"]
            IconBuilder["Icon Builder"]
            IconAssets["Icon Assets"]
            IconComponents["Svelte Components"]
            IconPlugin["Vite Plugin"]
        end

        subgraph Components["Component Library"]
            Modal["Modal Dialog"]
            ContentSearch["Content Search"]
            ColorPicker["Colour Picker"]
            ButtonRadio["Button Radio"]
        end
    end

    %% Relationships
    Canvas --> Core
    Elements --> Toolbar
    Theme --> Elements
    Theme --> Toolbar
    Icons --> Elements
    Icons --> Toolbar
    Components --> Elements
    Components --> Toolbar

    %% Component Relationships
    ElementManager --> BaseClasses
    BaseClasses --> MCE
    BaseClasses --> Svelte
    BaseClasses --> ClientEnabled
    Panel --> Search
    Panel --> Tooltip
    ThemeLoader --> ThemeUtils
    ThemeUtils --> ElementTheme
    IconBuilder --> IconAssets
    IconBuilder --> IconComponents
    IconComponents --> IconPlugin

    %% Click Events
    click Elements "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/elements/"
    click BaseClasses "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/elements/generic/"
    click MCE "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/elements/generic/mceElement.ts"
    click Svelte "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/elements/generic/svelteElement.ts"
    click ClientEnabled "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/elements/generic/client-enabled/"
    click Panel "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/toolbar/elementPanel.svelte"
    click Tooltip "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/toolbar/elementTooltip.svelte"
    click Icons "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/icons/"
    click IconBuilder "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/icons/buildIcons.ts"
    click IconAssets "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/icons/assets/"
    click IconComponents "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/icons/svelte/"
    click IconPlugin "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/icons/vite/vite-plugin-icons.ts"
    click ThemeLoader "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/theme-loader.ts"
    click ThemeUtils "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/util/theme.ts"
    click ElementTheme "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/elements/generic/elementClassTheme.ts"
    click CanvasTypes "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/util/types/canvas.d.ts"
    click CourseEnv "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/util/courseEnv.ts"
    click TinyMCE "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/public/demo-assets/canvas-tinymce.js"
    click Modal "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/components/modalDialog/"
    click ContentSearch "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/tree/main/src/lib/components/contentSearch/"
    click ColorPicker "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/components/colourPicker.svelte"
    click ButtonRadio "https://github.com/Ranga-Auaha-Ako/canvas-design-blocks/blob/main/src/lib/components/buttonRadio.svelte"

    %% Styling
    classDef canvas fill:#2196F3,stroke:#1565C0,color:white
    classDef core fill:#4CAF50,stroke:#2E7D32,color:white
    classDef element fill:#FF9800,stroke:#EF6C00,color:white
    classDef ui fill:#9C27B0,stroke:#6A1B9A,color:white
    classDef external fill:#9E9E9E,stroke:#616161,color:white

    class Canvas,CanvasTypes,CourseEnv,TinyMCE canvas
    class Core,Theme,Icons core
    class Elements,BaseClasses,MCE,Svelte,ClientEnabled,ElementManager element
    class Toolbar,Panel,Search,Tooltip,Components,Modal,ContentSearch,ColorPicker,ButtonRadio ui
    class ThemeLoader,ThemeUtils,ElementTheme,IconBuilder,IconAssets,IconComponents,IconPlugin external
```
