# yuanxiao-mmc/electron-tab-containers architecture

> Architecture diagram of the GitHub repository yuanxiao-mmc/electron-tab-containers, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yuanxiao-mmc/electron-tab-containers
- Repository: https://github.com/yuanxiao-mmc/electron-tab-containers

## Overview

##### Project Type and Purpose
- This is an Electron desktop application demo showcasing multi‑tab support using BrowserView.
- The goal is to let users open and manage multiple “tabs” (BrowserView instances) within a single BrowserWindow.

##### File Structure Analysis
- Top‑level:
- index.html: entry point for the renderer UI
- package.json, tsconfig.json, vite.config.ts: define dependencies, TypeScript setup, and build tooling (Vite)
- render/ (Renderer source before bundling)
- main.ts: bootstraps renderer process
- tabs/index.ts & style.css: tab bar UI
- utils/event-manager.ts, gnb.desktop.ts: renderer helpers for event dispatching and global navigation bar
- src/ (Main‑process code)
- main.ts: Electron app lifecycle, creates BrowserWindow via window/index.ts, sets up IPC
- window/index.ts: encapsulates BrowserWindow creation and options
- container/container.ts: manages BrowserView instances (open, close, switch)
- service/index.ts: any background services or business logic
- helpers/preload.js & event‑bus.ts: preload script exposing IPC channels and an internal event bus
- pages, const.ts: static or dynamic page definitions and constants

##### README Insights
- Confirms use of BrowserView for multi‑tab functionality.
- References an article for deeper implementation details.

##### Components
a. Main Electron Process
– App lifecycle (app.on ready, quit)
– Window Manager (creates BrowserWindow)
– Container Manager (creates/manages BrowserView tabs)
– Service Layer (background logic)
b. Renderer Processes
– Main Renderer (UI host for tab bar and controls)
– Individual BrowserViews (each tab loads a URL or page)
c. Preload & IPC
– Preload injects event‑bus API into renderer
– IPC channels for commands (openTab, closeTab, switchTab)
d. Build & Tooling
– Vite bundler for render/
– TypeScript compiler

##### Data Flows & Interactions
- User clicks “new tab” in renderer → event‑manager dispatches via preload → IPC to main process → container.createBrowserView()
- main process attaches BrowserView to BrowserWindow → view loads its own render bundle or URL
- Renderer UI subscribes to event‑bus updates (tab list changes)

##### Architectural Patterns
- Main vs. Renderer separation: clear division of responsibilities
- Event Bus / IPC: decoupled messaging between processes
- Container Pattern: BrowserView instances managed by a single controller

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Main Process Layer
    subgraph "Main Process"
        direction TB
        MainElectron["Main Electron Process"]:::main
        WindowManager["Window Manager\n(BrowserWindow)"]:::main
        ContainerEntry["Container Entry\n(src/container/index.ts)"]:::main
        ContainerManager["Container Manager\n(BrowserView lifecycle)"]:::main
        ServiceLayer["Service Layer"]:::main
        Constants["Constants & Pages\n(src/const.ts)"]:::main
        Pages["Pages Module"]:::main
        Preload["Preload Script\n(exposes IPC)"]:::main
        EventBusMain["Event Bus\n(internal messaging)"]:::main
        WebHelper["Web Helper"]:::main

        MainElectron -->|"on ready"| WindowManager
        MainElectron --> ServiceLayer
        MainElectron --> ContainerEntry
        ContainerEntry --> ContainerManager
        ContainerManager --> WindowManager
        ContainerManager -->|loads page definitions| Constants
        ContainerManager --> Pages
        ContainerManager --> WebHelper
        ContainerManager --> EventBusMain
        EventBusMain --> Preload
        Preload -->|"IPC channels"| MainElectron
    end

    %% Renderer Process Layer
    subgraph "Renderer Process"
        direction TB
        RendererHTML["Renderer HTML Host\n(index.html)"]:::renderer
        RendererEntry["Renderer Entry\n(render/main.ts)"]:::renderer
        TabBarUI["Tab Bar UI\n(render/tabs/index.ts)"]:::renderer
        TabBarStyle["Tab Bar Styles\n(style.css)"]:::renderer
        RendererEventMgr["Renderer Event Manager\n(event-manager.ts)"]:::renderer
        GNBHelper["Global Nav Bar Helper\n(gnb.desktop.ts)"]:::renderer

        RendererHTML --> RendererEntry
        RendererEntry --> TabBarUI
        TabBarUI --> TabBarStyle
        RendererEntry --> RendererEventMgr
        RendererEntry --> GNBHelper

        TabBarUI -->|"openTab/closeTab/switchTab"| Preload
        RendererEventMgr -->|"openTab/closeTab/switchTab"| Preload
    end

    %% Build & Tooling
    subgraph "Build & Tooling"
        direction TB
        TSConfig["tsconfig.json"]:::tooling
        ViteConfig["vite.config.ts"]:::tooling
        PackageJSON["package.json"]:::tooling

        TSConfig --> RendererEntry
        ViteConfig --> RendererEntry
        PackageJSON --> MainElectron
        PackageJSON --> RendererEntry
    end

    %% Legend
    subgraph Legend
        direction TB
        A["Main Process"]:::main
        B["Renderer Process"]:::renderer
        C["Tooling"]:::tooling
    end

    %% Click Events
    click MainElectron "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/main.ts"
    click WindowManager "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/window/index.ts"
    click ContainerEntry "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/container/index.ts"
    click ContainerManager "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/container/container.ts"
    click ServiceLayer "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/service/index.ts"
    click Constants "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/const.ts"
    click Pages "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/pages/index.ts"
    click Preload "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/helpers/preload.js"
    click EventBusMain "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/helpers/event-bus.ts"
    click WebHelper "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/src/helpers/web.ts"
    click RendererEntry "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/render/main.ts"
    click RendererHTML "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/index.html"
    click TabBarUI "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/render/tabs/index.ts"
    click TabBarStyle "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/render/tabs/style.css"
    click RendererEventMgr "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/render/utils/event-manager.ts"
    click GNBHelper "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/render/utils/gnb.desktop.ts"
    click TSConfig "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/tsconfig.json"
    click ViteConfig "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/vite.config.ts"
    click PackageJSON "https://github.com/yuanxiao-mmc/electron-tab-containers/blob/master/package.json"

    %% Styles
    classDef main fill:#D0E6FF,stroke:#333,stroke-width:1px
    classDef renderer fill:#DFFFE0,stroke:#333,stroke-width:1px
    classDef tooling fill:#FFF0B3,stroke:#333,stroke-width:1px
```
