# youzan/vant architecture

> Architecture diagram of the GitHub repository youzan/vant, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/youzan/vant
- Repository: https://github.com/youzan/vant

## Overview

Vant is a Vue component library for mobile web apps, with a large component package and a companion documentation/demo site and ecosystem packages. The main user workflow is to import components and styles into a Vue app, register components, and render them. The graph preserves documented capabilities and major sampled modules; relationships among unsampled component families are omitted rather than inferred.

Main entry points: [`packages/vant/src/field/Field.tsx`](https://github.com/youzan/vant/blob/main/packages/vant/src/field/Field.tsx) (Field Forms), [`packages/vant/src/image-preview/ImagePreviewItem.tsx`](https://github.com/youzan/vant/blob/main/packages/vant/src/image-preview/ImagePreviewItem.tsx) (Preview Gestures), [`packages/vant/src/utils/index.ts`](https://github.com/youzan/vant/blob/main/packages/vant/src/utils/index.ts) (Component Utilities), [`packages/vant/src/composables/use-expose.ts`](https://github.com/youzan/vant/blob/main/packages/vant/src/composables/use-expose.ts) (Public API Exposure)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Vue UI Library"]
  node_vant["Vant Components"]
  node_cell["Cell<br/>[Cell.tsx]"]
  node_field["Field Forms<br/>[Field.tsx]"]
  node_search["Search Field<br/>[Search.tsx]"]
  node_image["Image<br/>[Image.tsx]"]
  node_imagepreview["Image Preview<br/>[ImagePreview.tsx]"]
  node_previewitem["Preview Gestures"]
  node_uploader["Uploader Preview"]
  node_calendar["Calendar"]
  node_tabs["Tabs"]
end

subgraph group_shared["Shared Runtime"]
  node_utils["Component Utilities<br/>[index.ts]"]
  node_dom["DOM Utilities<br/>[dom.ts]"]
  node_format["Format Utilities<br/>[format.ts]"]
  node_expose["Public API Exposure<br/>[use-expose.ts]"]
  node_useid["Component IDs<br/>[use-id.ts]"]
end

subgraph group_docs["Docs and Demos"]
  node_docsdesktop["Desktop Docs<br/>[App.vue]"]
  node_docslayout["Docs Layout<br/>[index.vue]"]
  node_demoplayground["Demo Playground<br/>[DemoPlayground.vue]"]
  node_mobileapp["Mobile Demos<br/>[App.vue]"]
  node_iframesync["Theme Sync<br/>[iframe-sync.js]"]
  node_locales["Site Locales<br/>[locales.js]"]
end

subgraph group_ecosystem["Ecosystem Packages"]
  node_areadata[("Area Data<br/>[index.ts]")]
  node_resolver["Auto Import Resolver<br/>[index.ts]"]
  node_compat["Compatibility APIs"]
  node_touch["Touch Emulator<br/>[index.js]"]
end

subgraph group_scaffold["Project Scaffolding"]
  node_scaffoldgen["App Generator<br/>[generator.ts]"]
end

node_developer(("Vue Developer"))
node_vueapp["Vue App"]

node_developer -->|"builds with"| node_vueapp
node_vueapp -->|"imports and registers"| node_vant
node_field -->|"renders"| node_cell
node_field -->|"uses"| node_useid
node_field -->|"uses"| node_expose
node_field -->|"imports"| node_utils
node_field -->|"imports"| node_dom
node_search -->|"renders"| node_field
node_imagepreview -->|"renders"| node_previewitem
node_imagepreview -->|"uses"| node_expose
node_previewitem -->|"uses"| node_expose
node_previewitem -->|"uses"| node_image
node_previewitem -->|"imports"| node_utils
node_uploader -->|"renders"| node_image
node_uploader -->|"imports"| node_utils
node_docsdesktop -->|"renders"| node_docslayout
node_docsdesktop -->|"sets language"| node_locales
node_demoplayground -.->|"integrates"| node_iframesync
node_mobileapp -->|"reads theme"| node_iframesync
node_developer -.->|"creates project"| node_scaffoldgen

click node_vant "https://github.com/youzan/vant/tree/main/packages/vant/src"
click node_cell "https://github.com/youzan/vant/blob/main/packages/vant/src/cell/Cell.tsx"
click node_field "https://github.com/youzan/vant/blob/main/packages/vant/src/field/Field.tsx"
click node_search "https://github.com/youzan/vant/blob/main/packages/vant/src/search/Search.tsx"
click node_image "https://github.com/youzan/vant/blob/main/packages/vant/src/image/Image.tsx"
click node_imagepreview "https://github.com/youzan/vant/blob/main/packages/vant/src/image-preview/ImagePreview.tsx"
click node_previewitem "https://github.com/youzan/vant/blob/main/packages/vant/src/image-preview/ImagePreviewItem.tsx"
click node_uploader "https://github.com/youzan/vant/blob/main/packages/vant/src/uploader/UploaderPreviewItem.tsx"
click node_calendar "https://github.com/youzan/vant/tree/main/packages/vant/src/calendar"
click node_tabs "https://github.com/youzan/vant/tree/main/packages/vant/src/tabs"
click node_utils "https://github.com/youzan/vant/blob/main/packages/vant/src/utils/index.ts"
click node_dom "https://github.com/youzan/vant/blob/main/packages/vant/src/utils/dom.ts"
click node_format "https://github.com/youzan/vant/blob/main/packages/vant/src/utils/format.ts"
click node_expose "https://github.com/youzan/vant/blob/main/packages/vant/src/composables/use-expose.ts"
click node_useid "https://github.com/youzan/vant/blob/main/packages/vant/src/composables/use-id.ts"
click node_docsdesktop "https://github.com/youzan/vant/blob/main/packages/vant-cli/site/desktop/App.vue"
click node_docslayout "https://github.com/youzan/vant/blob/main/packages/vant-cli/site/desktop/components/index.vue"
click node_demoplayground "https://github.com/youzan/vant/blob/main/packages/vant-cli/site/desktop/components/DemoPlayground.vue"
click node_mobileapp "https://github.com/youzan/vant/blob/main/packages/vant-cli/site/mobile/App.vue"
click node_iframesync "https://github.com/youzan/vant/blob/main/packages/vant-cli/site/common/iframe-sync.js"
click node_locales "https://github.com/youzan/vant/blob/main/packages/vant-cli/site/common/locales.js"
click node_areadata "https://github.com/youzan/vant/blob/main/packages/vant-area-data/src/index.ts"
click node_resolver "https://github.com/youzan/vant/blob/main/packages/vant-auto-import-resolver/src/index.ts"
click node_compat "https://github.com/youzan/vant/tree/main/packages/vant-compat/src"
click node_touch "https://github.com/youzan/vant/blob/main/packages/vant-touch-emulator/src/index.js"
click node_scaffoldgen "https://github.com/youzan/vant/blob/main/packages/create-vant-cli-app/src/generator.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_vant,node_cell,node_field,node_search,node_image,node_imagepreview,node_previewitem,node_uploader,node_calendar,node_tabs toneBlue
class node_utils,node_dom,node_format,node_expose,node_useid toneAmber
class node_docsdesktop,node_docslayout,node_demoplayground,node_mobileapp,node_iframesync,node_locales toneMint
class node_areadata,node_resolver,node_compat,node_touch toneRose
class node_scaffoldgen,node_developer,node_vueapp toneIndigo
```

## Components

### Vue UI Library

- [Vant Components](https://github.com/youzan/vant/tree/main/packages/vant/src): `packages/vant/src`
- [Cell](https://github.com/youzan/vant/blob/main/packages/vant/src/cell/Cell.tsx): `packages/vant/src/cell/Cell.tsx`
- [Field Forms](https://github.com/youzan/vant/blob/main/packages/vant/src/field/Field.tsx): `packages/vant/src/field/Field.tsx`
- [Search Field](https://github.com/youzan/vant/blob/main/packages/vant/src/search/Search.tsx): `packages/vant/src/search/Search.tsx`
- [Image](https://github.com/youzan/vant/blob/main/packages/vant/src/image/Image.tsx): `packages/vant/src/image/Image.tsx`
- [Image Preview](https://github.com/youzan/vant/blob/main/packages/vant/src/image-preview/ImagePreview.tsx): `packages/vant/src/image-preview/ImagePreview.tsx`
- [Preview Gestures](https://github.com/youzan/vant/blob/main/packages/vant/src/image-preview/ImagePreviewItem.tsx): `packages/vant/src/image-preview/ImagePreviewItem.tsx`
- [Uploader Preview](https://github.com/youzan/vant/blob/main/packages/vant/src/uploader/UploaderPreviewItem.tsx): `packages/vant/src/uploader/UploaderPreviewItem.tsx`
- [Calendar](https://github.com/youzan/vant/tree/main/packages/vant/src/calendar): `packages/vant/src/calendar`
- [Tabs](https://github.com/youzan/vant/tree/main/packages/vant/src/tabs): `packages/vant/src/tabs`

### Shared Runtime

- [Component Utilities](https://github.com/youzan/vant/blob/main/packages/vant/src/utils/index.ts): `packages/vant/src/utils/index.ts`
- [DOM Utilities](https://github.com/youzan/vant/blob/main/packages/vant/src/utils/dom.ts): `packages/vant/src/utils/dom.ts`
- [Format Utilities](https://github.com/youzan/vant/blob/main/packages/vant/src/utils/format.ts): `packages/vant/src/utils/format.ts`
- [Public API Exposure](https://github.com/youzan/vant/blob/main/packages/vant/src/composables/use-expose.ts): `packages/vant/src/composables/use-expose.ts`
- [Component IDs](https://github.com/youzan/vant/blob/main/packages/vant/src/composables/use-id.ts): `packages/vant/src/composables/use-id.ts`

### Docs and Demos

- [Desktop Docs](https://github.com/youzan/vant/blob/main/packages/vant-cli/site/desktop/App.vue): `packages/vant-cli/site/desktop/App.vue`
- [Docs Layout](https://github.com/youzan/vant/blob/main/packages/vant-cli/site/desktop/components/index.vue): `packages/vant-cli/site/desktop/components/index.vue`
- [Demo Playground](https://github.com/youzan/vant/blob/main/packages/vant-cli/site/desktop/components/DemoPlayground.vue): `packages/vant-cli/site/desktop/components/DemoPlayground.vue`
- [Mobile Demos](https://github.com/youzan/vant/blob/main/packages/vant-cli/site/mobile/App.vue): `packages/vant-cli/site/mobile/App.vue`
- [Theme Sync](https://github.com/youzan/vant/blob/main/packages/vant-cli/site/common/iframe-sync.js): `packages/vant-cli/site/common/iframe-sync.js`
- [Site Locales](https://github.com/youzan/vant/blob/main/packages/vant-cli/site/common/locales.js): `packages/vant-cli/site/common/locales.js`

### Ecosystem Packages

- [Area Data](https://github.com/youzan/vant/blob/main/packages/vant-area-data/src/index.ts): `packages/vant-area-data/src/index.ts`
- [Auto Import Resolver](https://github.com/youzan/vant/blob/main/packages/vant-auto-import-resolver/src/index.ts): `packages/vant-auto-import-resolver/src/index.ts`
- [Compatibility APIs](https://github.com/youzan/vant/tree/main/packages/vant-compat/src): `packages/vant-compat/src`
- [Touch Emulator](https://github.com/youzan/vant/blob/main/packages/vant-touch-emulator/src/index.js): `packages/vant-touch-emulator/src/index.js`

### Project Scaffolding

- [App Generator](https://github.com/youzan/vant/blob/main/packages/create-vant-cli-app/src/generator.ts): `packages/create-vant-cli-app/src/generator.ts`

### Other components

- **Vue Developer**
- **Vue App**

## Connections

- Vue Developer → Vue App: builds with
- Vue App → Vant Components: imports and registers
- Field Forms → Cell: renders (evidence: `packages/vant/src/field/Field.tsx`)
- Field Forms → Component IDs: uses (evidence: `packages/vant/src/field/Field.tsx`)
- Field Forms → Public API Exposure: uses (evidence: `packages/vant/src/field/Field.tsx`)
- Field Forms → Component Utilities: imports (evidence: `packages/vant/src/field/Field.tsx`)
- Field Forms → DOM Utilities: imports (evidence: `packages/vant/src/field/Field.tsx`)
- Search Field → Field Forms: renders (evidence: `packages/vant/src/search/Search.tsx`)
- Image Preview → Preview Gestures: renders (evidence: `packages/vant/src/image-preview/ImagePreview.tsx`)
- Image Preview → Public API Exposure: uses (evidence: `packages/vant/src/image-preview/ImagePreview.tsx`)
- Preview Gestures → Public API Exposure: uses (evidence: `packages/vant/src/image-preview/ImagePreviewItem.tsx`)
- Preview Gestures → Image: uses (evidence: `packages/vant/src/image-preview/ImagePreviewItem.tsx`)
- Preview Gestures → Component Utilities: imports (evidence: `packages/vant/src/image-preview/ImagePreviewItem.tsx`)
- Uploader Preview → Image: renders (evidence: `packages/vant/src/uploader/UploaderPreviewItem.tsx`)
- Uploader Preview → Component Utilities: imports (evidence: `packages/vant/src/uploader/UploaderPreviewItem.tsx`)
- Desktop Docs → Docs Layout: renders (evidence: `packages/vant-cli/site/desktop/App.vue`)
- Desktop Docs → Site Locales: sets language (evidence: `packages/vant-cli/site/desktop/App.vue`)
- Demo Playground → Theme Sync: integrates
- Mobile Demos → Theme Sync: reads theme (evidence: `packages/vant-cli/site/mobile/App.vue`)
- Vue Developer → App Generator: creates project
