# vexip-ui/vexip-ui architecture

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

- Interactive diagram: https://gitdiagram.com/vexip-ui/vexip-ui
- Repository: https://github.com/vexip-ui/vexip-ui

## Overview

##### Project type and purpose
- This is a Vue-based UI component library (Vexip UI), organized as a monorepo using pnpm workspaces.

##### File structure
- Top-level directories/packages:
- components/… (all Vue components and related CSS/TS helpers/tests)
- directives/… (Vue directives)
- style/… (global SCSS files, themes, design tokens)
- docs/… (VitePress-based documentation source and public assets)
- dev-server/… (local demo server to browse components during development)
- playground/… (stand-alone playground app for testing, demos, downloads)
- scripts/… (build, publish, test, release utilities)
- configuration & tooling (tsconfig.json, vite.config.ts, vitest.config.ts, full-lib.ts, gulpfile.mjs)
- CI/CD (​.github/workflows/*.yml), patches/, netlify.toml, pnpm-workspace.yaml

##### README for additional insights
- Purpose: deliver highly configurable, TypeScript-first Vue 3 components with global/local default overrides, CSS variables, dark theme, i18n, SSR, resolver support, accessibility, tests.
- Build & deploy: published to npm, docs hosted online.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Actors
    Developer["Developer"]:::external

    %% Subgraphs
    subgraph "Monorepo Root" 
        MonorepoRoot["Monorepo Root"]:::source
    end

    subgraph "Shared Packages" 
        BemHelper["bem-helper"]:::source
        ConfigPkg["config"]:::source
        Hooks["hooks"]:::source
        Icons["icons"]:::source
        Meta["meta"]:::source
        Plugins["plugins"]:::source
        ScriptsPkg["scripts"]:::source
        Utils["utils"]:::source
    end

    subgraph "Component Library" 
        Components["components/"]:::source
        Directives["directives/"]:::source
    end

    subgraph "Styling System" 
        StyleSys["style/"]:::source
    end

    subgraph "Dev & Test Tools" 
        DevServer["dev-server/"]:::dev
        Playground["playground/"]:::dev
        VitestConf["Vitest Config"]:::dev
    end

    subgraph "Build & Packaging" 
        Scripts["scripts/"]:::build
        Gulp["gulpfile.mjs"]:::build
        FullLib["full-lib.ts"]:::build
        Vite1["vite.config.ts"]:::build
        Vite2["vite.full.config.ts"]:::build
        TSConfig["tsconfig.json"]:::build
    end

    subgraph "Documentation Site" 
        VitePressCfg[".vitepress/"]:::build
        DocsEN["en-US/"]:::build
        DocsCN["zh-CN/"]:::build
        DocsPublic["public/"]:::build
        DocsIndex["index.md"]:::build
    end

    subgraph "CI/CD Pipelines" 
        CI["ci.yml"]:::build
        PublishYML["publish.yml"]:::build
        ReleaseYML["release.yml"]:::build
        DeployDocsYML["deploy-docs.yml"]:::build
    end

    subgraph "External Services" 
        NPM["npm Registry"]:::output
        DocsHost["Docs Hosting"]:::output
        GitHub["GitHub"]:::output
    end

    %% Relationships
    Developer --> MonorepoRoot
    MonorepoRoot --> SharedPackages[/"Shared Packages"/]
    MonorepoRoot --> ComponentLibrary[/"Component Library"/]
    MonorepoRoot --> StylingSystem[/"Styling System"/]
    MonorepoRoot --> DevAndTest[/"Dev & Test Tools"/]
    MonorepoRoot --> BuildAndPkg[/"Build & Packaging"/]
    MonorepoRoot --> Documentation[/"Documentation Site"/]
    MonorepoRoot --> CICD[/"CI/CD Pipelines"/]

    SharedPackages --> Scripts
    ComponentLibrary --> Scripts
    StylingSystem --> Scripts

    SharedPackages --> DevServer
    ComponentLibrary --> DevServer
    StylingSystem --> DevServer
    SharedPackages --> Playground
    ComponentLibrary --> Playground

    Scripts --> NPM
    Gulp --> NPM
    FullLib --> NPM
    Vite1 --> NPM
    Vite2 --> NPM

    Documentation --> DocsHost

    CI --> VitestConf
    CI --> Scripts
    CI --> DeployDocsYML
    CI --> PublishYML
    CI --> ReleaseYML
    PublishYML --> NPM
    DeployDocsYML --> DocsHost

    GitHub --> CI

    %% Click Events
    click MonorepoRoot "https://github.com/vexip-ui/vexip-ui/blob/main/pnpm-workspace.yaml"
    click BemHelper "https://github.com/vexip-ui/vexip-ui/tree/main/common/bem-helper"
    click ConfigPkg "https://github.com/vexip-ui/vexip-ui/tree/main/common/config"
    click Hooks "https://github.com/vexip-ui/vexip-ui/tree/main/common/hooks"
    click Icons "https://github.com/vexip-ui/vexip-ui/tree/main/common/icons"
    click Meta "https://github.com/vexip-ui/vexip-ui/tree/main/common/meta"
    click Plugins "https://github.com/vexip-ui/vexip-ui/tree/main/common/plugins"
    click ScriptsPkg "https://github.com/vexip-ui/vexip-ui/tree/main/common/scripts"
    click Utils "https://github.com/vexip-ui/vexip-ui/tree/main/common/utils"
    click Components "https://github.com/vexip-ui/vexip-ui/tree/main/components/"
    click Directives "https://github.com/vexip-ui/vexip-ui/tree/main/directives/"
    click StyleSys "https://github.com/vexip-ui/vexip-ui/tree/main/style/"
    click DevServer "https://github.com/vexip-ui/vexip-ui/tree/main/dev-server/"
    click Playground "https://github.com/vexip-ui/vexip-ui/tree/main/playground/"
    click VitestConf "https://github.com/vexip-ui/vexip-ui/blob/main/vitest.config.ts"
    click Scripts "https://github.com/vexip-ui/vexip-ui/tree/main/scripts/"
    click Gulp "https://github.com/vexip-ui/vexip-ui/blob/main/gulpfile.mjs"
    click FullLib "https://github.com/vexip-ui/vexip-ui/blob/main/full-lib.ts"
    click Vite1 "https://github.com/vexip-ui/vexip-ui/blob/main/vite.config.ts"
    click Vite2 "https://github.com/vexip-ui/vexip-ui/blob/main/vite.full.config.ts"
    click TSConfig "https://github.com/vexip-ui/vexip-ui/blob/main/tsconfig.json"
    click VitePressCfg "https://github.com/vexip-ui/vexip-ui/tree/main/docs/.vitepress/"
    click DocsEN "https://github.com/vexip-ui/vexip-ui/tree/main/docs/en-US/"
    click DocsCN "https://github.com/vexip-ui/vexip-ui/tree/main/docs/zh-CN/"
    click DocsPublic "https://github.com/vexip-ui/vexip-ui/tree/main/docs/public/"
    click DocsIndex "https://github.com/vexip-ui/vexip-ui/blob/main/docs/index.md"
    click CI "https://github.com/vexip-ui/vexip-ui/blob/main/ .github/workflows/ci.yml"
    click PublishYML "https://github.com/vexip-ui/vexip-ui/blob/main/ .github/workflows/publish.yml"
    click ReleaseYML "https://github.com/vexip-ui/vexip-ui/blob/main/ .github/workflows/release.yml"
    click DeployDocsYML "https://github.com/vexip-ui/vexip-ui/blob/main/ .github/workflows/deploy-docs.yml"

    %% Styles
    classDef source fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef dev fill:#d4edda,stroke:#333,stroke-width:1px
    classDef build fill:#fff3cd,stroke:#333,stroke-width:1px
    classDef output fill:#e2d5f7,stroke:#333,stroke-width:1px
    classDef external fill:#f8f9fa,stroke:#333,stroke-width:1px
```
