# knxcloud/lowcode-engine-vue architecture

> Architecture diagram of the GitHub repository knxcloud/lowcode-engine-vue, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/knxcloud/lowcode-engine-vue
- Repository: https://github.com/knxcloud/lowcode-engine-vue

## Overview

##### Project type and purpose
- This is an open‑source, monorepo‑based low‑code Vue renderer and adapter suite.
- It provides a core data‑source engine, hook utilities, common utilities, a Vue renderer package (mapping low‑code schemas to Vue VNodes and lifecycles), and a Vue simulator renderer for canvas‑style previews.

##### File structure
- Root: pnpm workspace, shared configs (.eslintrc, tsconfig.json, husky, etc.), build scripts
- packages/data-source: core engine (fetch, engine, interface, handler registry)
- packages/hooks: render‑context and current‑node hooks for the renderer
- packages/utils: asset management, build helpers, schema utilities, environment setup
- packages/vue-renderer: Vue‑specific renderer (lifecycle adapters, renderers for block/component/page, data‑source integration)
- packages/vue-simulator-renderer: on‑canvas simulator (host component, built‑in components, simulator view, utility functions)

##### README for additional insights
- Integrates with @alilc/lowcode-engine via init() and project context
- Supports React→Vue lifecycle mapping, async setup, Suspense for data‑source init
- Demonstrates Vue Router page integration via LOWCODE_ROUTE_META

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Tools
    subgraph "Developer Tools"
        CLI["Developer CLI Scaffold"]:::devtools
    end

    %% Core Engine Layer
    subgraph "Core Engine Layer"
        LC_EngineHost["Low-Code Engine Host"]:::core
        DataSource["Data-Source Engine"]:::core
    end

    %% Hooks & Utils Layer
    subgraph "Hooks & Utils Layer"
        Hooks["Hooks Layer"]:::utils
        Utils["Utils Library"]:::utils
    end

    %% Renderer Layer
    subgraph "Renderer Layer"
        VueRenderer["Vue Renderer"]:::renderer
    end

    %% Simulator Layer
    subgraph "Simulator Layer"
        VueSimulator["Vue Simulator Renderer"]:::renderer
    end

    %% External Runtimes
    subgraph "External Runtimes"
        Vue3["Vue 3 Runtime"]:::external
        VueRouter["Vue Router"]:::external
        Suspense["Vue Suspense"]:::external
    end

    %% Connections
    CLI -->|"scaffold assets.json"| LC_EngineHost
    LC_EngineHost -->|"init()/loadMaterials()"| DataSource
    VueRenderer -->|"adapter→"| DataSource
    VueRenderer -->|"hooks API"| Hooks
    VueRenderer -->|"utils API"| Utils
    VueSimulator -->|"wraps renderer"| VueRenderer
    VueRouter -->|"LOWCODE_ROUTE_META"| VueRenderer
    Suspense -->|"data-source init"| VueRenderer
    Vue3 -->|"runtime support"| VueRenderer
    Vue3 -->|"runtime support"| VueSimulator

    %% Click Events
    click CLI "https://github.com/knxcloud/lowcode-engine-vue/blob/main/package.json"
    click LC_EngineHost "https://github.com/knxcloud/lowcode-engine-vue/tree/main/@alilc/lowcode-engine"
    click DataSource "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/data-source/src"
    click DataCore "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/data-source/src/core/engine.ts"
    click DataInterface "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/data-source/src/core/interface.ts"
    click DataHandlers "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/data-source/src/handlers"
    click Hooks "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/hooks/src"
    click RenderContext "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/hooks/src/renderer-context.ts"
    click CurrentNode "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/hooks/src/current-node.ts"
    click Utils "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/utils/src"
    click Asset "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/utils/src/asset.ts"
    click Schema "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/utils/src/schema.ts"
    click SetupEnv "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/utils/src/setup-environment.ts"
    click VueRenderer "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/vue-renderer/src"
    click Lifecycles "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/vue-renderer/src/core/lifecycles"
    click BaseRenderer "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/vue-renderer/src/core/base.ts"
    click Renderers "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/vue-renderer/src/renderers"
    click DataSourceAdapter "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/vue-renderer/src/data-source/index.ts"
    click VueSimulator "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/vue-simulator-renderer/src"
    click Host "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/vue-simulator-renderer/src/host.ts"
    click SimulatorCore "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/vue-simulator-renderer/src/simulator.ts"
    click Builtin "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/vue-simulator-renderer/src/buildin-components"
    click SimView "https://github.com/knxcloud/lowcode-engine-vue/blob/main/packages/vue-simulator-renderer/src/simulator-view.ts"
    click SimUtils "https://github.com/knxcloud/lowcode-engine-vue/tree/main/packages/vue-simulator-renderer/src/utils"

    %% Styles
    classDef core fill:#D6E9F8,stroke:#31708F,stroke-width:1px
    classDef utils fill:#DFF0D8,stroke:#3C763D,stroke-width:1px
    classDef renderer fill:#FCF8E3,stroke:#8A6D3B,stroke-width:1px
    classDef external fill:#EEEEEE,stroke:#AAAAAA,stroke-width:1px
    classDef devtools fill:#F2DEDE,stroke:#A94442,stroke-width:1px
```
