# ecloudhub/spark architecture

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

- Interactive diagram: https://gitdiagram.com/ecloudhub/spark
- Repository: https://github.com/ecloudhub/spark

## Overview

##### Project type and purpose
- Spark is a React component library published as `@ecloud-spark`.
- It provides reusable UI components (buttons, menus, scroll‐triggered animations) and hooks (window size, media query, isomorphic layout effect).
- There’s also a Next.js–based “showcase” demo app that imports and demonstrates the components.

##### File structure
Top level:
- package.json, rollup.config.mjs → library build & publishing
- README.md → project overview
- / → standalone Next.js demo app
- src/ → raw component, hook, type source
Under src/:
- components/ → each component in its own folder (Button, MagneticButton, Menu, etc.)
- hooks/ → reusable React hooks
- config/ → configuration constants
- types/ → TypeScript interfaces for props
- index.ts → library entry point
Additional:
- tsconfig.json, .gitignore → standard config

##### README
- Confirms it’s a component library.
- Mentions dependencies (React, GSAP ScrollTrigger).
- Lists public API for components & hooks.

- Types (props definitions under types/)
- Config (variables.ts)
- Entry point (index.ts) → exports all components/hooks

##### Build & Publish Flow
- rollup.config.mjs reads index.ts → bundles for ESM & CJS → outputs to dist/ → package.json points to main/module → `npm publish`

- Next.js pages/_app, pages/index → import Spark components
- Local mock data (showcase/mock.ts)
- Uses global CSS (showcase/styles/globals.css)

- Any third‐party React app that installs `ecloud-spark` from NPM

- React (peerDep)
- GSAP ScrollTrigger plugin (peerDep)

Summary
[External Consumers]
↓
[Showcase App (Next.js)] → [Spark Library Package] → [External Dependencies]
↑
[Build & Publish Pipeline]
- Inside Spark Library, detail modules in a 2-column layout:
Components | Hooks
Types      | Config
- This will capture all essential architectural elements of Spark tailored for both the library and its demo showcase.

## Diagram (Mermaid)

```mermaid
flowchart TB
  subgraph "Spark Library"
    subgraph "Components"
      Button["Button"]:::comp
      ElasticButton["ElasticButton"]:::comp
      HPin["HPin"]:::comp
      MagneticButton["MagneticButton"]:::comp
      Menu["Menu"]:::comp
      Ribbons["Ribbons"]:::comp
      TextReader["TextReader"]:::comp
      TextReveal["TextReveal"]:::comp
      VOverlap["VOverlap"]:::comp
      VPin["VPin"]:::comp
    end
    subgraph "Hooks"
      documentHeight["document-height"]:::comp
      useIsoEffect["useIsomorphicLayoutEffect"]:::comp
      useMediaQuery["useMediaQuery"]:::comp
      useWindowSize["useWindowSize"]:::comp
    end
    subgraph "Types & Config"
      variables["variables.ts"]:::comp
      typesButton["button.ts"]:::comp
      typesMenu["menu.ts"]:::comp
      typesMisc["misc.ts"]:::comp
      typesOverlap["overlap.ts"]:::comp
      typesPin["pin.ts"]:::comp
      typesRibbon["ribbon.ts"]:::comp
      typesText["text.ts"]:::comp
    end
    index["src/index.ts"]:::entry
    compIndex["src/components/index.ts"]:::entry
    hookIndex["src/hooks/index.ts"]:::entry
  end

  subgraph "Build & Publish Pipeline"
    srcFolder["src/"]:::build
    rollup["rollup.config.mjs"]:::build
    tsconfig["tsconfig.json"]:::build
    dist["dist/"]:::build
    npmpub["NPM Registry"]:::external
  end

  subgraph "Showcase App (Next.js)"
    spkg["package.json"]:::demo
    nextcfg["next.config.js"]:::demo
    tscfg["tsconfig.json"]:::demo
    appPage["_app.tsx"]:::demo
    docPage["_document.tsx"]:::demo
    indexPage["index.tsx"]:::demo
    figCap["figure-caption.tsx"]:::demo
    mock["mock.ts"]:::demo
    globals["globals.css"]:::demo
  end

  EC["External Consumers"]:::external
  React["React"]:::dep
  GSAP["GSAP ScrollTrigger"]:::dep

  EC -->|"installs ecloud-spark"| index
  index -->|"exports"<| compIndex
  index -->|"exports"<| hookIndex
  compIndex -->|"includes"| Button
  compIndex --> ElasticButton
  compIndex --> HPin
  compIndex --> MagneticButton
  compIndex --> Menu
  compIndex --> Ribbons
  compIndex --> TextReader
  compIndex --> TextReveal
  compIndex --> VOverlap
  compIndex --> VPin
  hookIndex --> documentHeight
  hookIndex --> useIsoEffect
  hookIndex --> useMediaQuery
  hookIndex --> useWindowSize
  index -->|"references"| variables
  index --> typesButton
  index --> typesMenu
  index --> typesMisc
  index --> typesOverlap
  index --> typesPin
  index --> typesRibbon
  index --> typesText

  srcFolder --> rollup
  rollup --> dist
  rollup -->|"uses"| tsconfig
  dist --> npmpub
  npmpub --> EC

  appPage -->|"imports"| index
  indexPage -->|"examples using"| Button
  indexPage --> TextReveal
  indexPage --> useWindowSize
  figCap --> mock
  globals --> appPage

  index --> React
  index --> GSAP

  classDef comp fill:#E0F7FA,stroke:#006064
  classDef entry fill:#B2EBF2,stroke:#004D40
  classDef build fill:#C8E6C9,stroke:#2E7D32
  classDef demo fill:#F5F5F5,stroke:#757575
  classDef external fill:#FFF9C4,stroke:#F9A825
  classDef dep fill:#FFECB3,stroke:#FF6F00

  click rollup "https://github.com/ecloudhub/spark/blob/main/rollup.config.mjs"
  click tsconfig "https://github.com/ecloudhub/spark/blob/main/tsconfig.json"
  click srcFolder "https://github.com/ecloudhub/spark/tree/main/src/"
  click index "https://github.com/ecloudhub/spark/blob/main/src/index.ts"
  click compIndex "https://github.com/ecloudhub/spark/blob/main/src/components/index.ts"
  click hookIndex "https://github.com/ecloudhub/spark/blob/main/src/hooks/index.ts"
  click Button "https://github.com/ecloudhub/spark/blob/main/src/components/Button/Button.tsx"
  click ElasticButton "https://github.com/ecloudhub/spark/blob/main/src/components/ElasticButton/ElasticButton.tsx"
  click HPin "https://github.com/ecloudhub/spark/blob/main/src/components/HPin/HPin.tsx"
  click MagneticButton "https://github.com/ecloudhub/spark/blob/main/src/components/MagneticButton/MagneticButton.tsx"
  click Menu "https://github.com/ecloudhub/spark/blob/main/src/components/Menu/Menu.tsx"
  click Ribbons "https://github.com/ecloudhub/spark/blob/main/src/components/Ribbons/Ribbons.tsx"
  click TextReader "https://github.com/ecloudhub/spark/blob/main/src/components/TextReader/TextReader.tsx"
  click TextReveal "https://github.com/ecloudhub/spark/blob/main/src/components/TextReveal/TextReveal.tsx"
  click VOverlap "https://github.com/ecloudhub/spark/blob/main/src/components/VOverlap/VOverlap.tsx"
  click VPin "https://github.com/ecloudhub/spark/blob/main/src/components/VPin/VPin.tsx"
  click documentHeight "https://github.com/ecloudhub/spark/blob/main/src/hooks/document-height.ts"
  click useIsoEffect "https://github.com/ecloudhub/spark/blob/main/src/hooks/useIsomorphicEffect.ts"
  click useMediaQuery "https://github.com/ecloudhub/spark/blob/main/src/hooks/useMediaQuery.ts"
  click useWindowSize "https://github.com/ecloudhub/spark/blob/main/src/hooks/useWindowSize.tsx"
  click variables "https://github.com/ecloudhub/spark/blob/main/src/config/variables.ts"
  click typesButton "https://github.com/ecloudhub/spark/blob/main/src/types/button.ts"
  click typesMenu "https://github.com/ecloudhub/spark/blob/main/src/types/menu.ts"
  click typesMisc "https://github.com/ecloudhub/spark/blob/main/src/types/misc.ts"
  click typesOverlap "https://github.com/ecloudhub/spark/blob/main/src/types/overlap.ts"
  click typesPin "https://github.com/ecloudhub/spark/blob/main/src/types/pin.ts"
  click typesRibbon "https://github.com/ecloudhub/spark/blob/main/src/types/ribbon.ts"
  click typesText "https://github.com/ecloudhub/spark/blob/main/src/types/text.ts"
  click spkg "https://github.com/ecloudhub/spark/blob/main/showcase/package.json"
  click nextcfg "https://github.com/ecloudhub/spark/blob/main/showcase/next.config.js"
  click tscfg "https://github.com/ecloudhub/spark/blob/main/showcase/tsconfig.json"
  click appPage "https://github.com/ecloudhub/spark/blob/main/showcase/pages/_app.tsx"
  click docPage "https://github.com/ecloudhub/spark/blob/main/showcase/pages/_document.tsx"
  click indexPage "https://github.com/ecloudhub/spark/blob/main/showcase/pages/index.tsx"
  click figCap "https://github.com/ecloudhub/spark/blob/main/showcase/components/figure-caption.tsx"
  click mock "https://github.com/ecloudhub/spark/blob/main/showcase/mock.ts"
  click globals "https://github.com/ecloudhub/spark/blob/main/showcase/styles/globals.css"
```
