# xushanpei/open-file-viewer architecture

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

- Interactive diagram: https://gitdiagram.com/xushanpei/open-file-viewer
- Repository: https://github.com/xushanpei/open-file-viewer

## Overview

Open File Viewer is a browser-based file-preview SDK. A host application supplies a file or file queue, a container, and ordered format plugins; the viewer manages navigation, toolbar and preview state while plugins render supported formats or provide fallback behavior. The core also exposes support detection and framework adapters for React, Vue, and Svelte. The README documents broad format coverage, but several plugin implementations were not sampled; their nodes and viewer dispatch links reflect documented capabilities rather than inspected internals.

Main entry points: [`packages/core/src/viewer.ts`](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/viewer.ts) (Viewer and queue), [`packages/core/src/plugins/office.ts`](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/office.ts) (Office preview), [`packages/core/src/plugins/pdf.ts`](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/pdf.ts) (PDF preview), [`packages/react/src/index.tsx`](https://github.com/xushanpei/open-file-viewer/blob/main/packages/react/src/index.tsx) (React adapter)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["Host integrations"]
  node_react["React adapter<br/>[index.tsx]"]
  node_vue["Vue adapter<br/>[index.ts]"]
  node_svelte["Svelte adapter"]
end

subgraph group_runtime["Viewer runtime"]
  node_viewer["Viewer and queue<br/>[viewer.ts]"]
  node_support["Support check<br/>[support.ts]"]
end

subgraph group_formats["Format plugins"]
  node_image["Image preview<br/>[image.ts]"]
  node_pdf["PDF preview<br/>[pdf.ts]"]
  node_asset["Data and assets<br/>[asset.ts]"]
  node_media["Audio and video<br/>[audio.ts]"]
  node_text["Text and code<br/>[text.ts]"]
  node_archive["Archive preview<br/>[archive.ts]"]
  node_email["Email preview<br/>[email.ts]"]
  node_drawing["Drawing preview<br/>[drawing.ts]"]
  node_gis["GIS preview<br/>[gis.ts]"]
  node_model3d["3D preview<br/>[model3d.ts]"]
  node_fallback["Download fallback<br/>[fallback.ts]"]
end

subgraph group_office["Office and CAD"]
  node_office["Office preview<br/>[office.ts]"]
  node_legacyword["Legacy Word parser<br/>[msdoc.ts]"]
  node_legacydeck["Legacy PowerPoint parser<br/>[msppt.ts]"]
  node_wordml["WordML parser<br/>[wordml.ts]"]
  node_cad["CAD preview<br/>[cad.ts]"]
  node_cadformats["DWG and OASIS parsers<br/>[cad-dwg.ts]"]
end

subgraph group_services["Shared services"]
  node_detect["File normalization<br/>[detect.ts]"]
  node_dom["DOM utilities<br/>[dom.ts]"]
  node_messages["Messages and locale<br/>[messages.ts]"]
  node_utils["Plugin utilities<br/>[utils.ts]"]
end

node_host(("Web application"))

node_host -->|"configures"| node_viewer
node_host -->|"uses"| node_react
node_host -->|"uses"| node_vue
node_host -->|"uses"| node_svelte
node_react -->|"wraps"| node_viewer
node_vue -->|"wraps"| node_viewer
node_svelte -->|"creates"| node_viewer
node_viewer -->|"normalizes files"| node_detect
node_support -->|"normalizes source"| node_detect
node_viewer -->|"resolves container"| node_dom
node_viewer -->|"resolves locale"| node_messages
node_viewer -.->|"dispatches plugin"| node_image
node_viewer -.->|"dispatches plugin"| node_pdf
node_viewer -.->|"dispatches plugin"| node_asset
node_viewer -.->|"dispatches plugins"| node_media
node_viewer -.->|"dispatches plugin"| node_text
node_viewer -.->|"dispatches plugin"| node_archive
node_viewer -.->|"dispatches plugin"| node_email
node_viewer -.->|"dispatches plugin"| node_drawing
node_viewer -.->|"dispatches plugin"| node_gis
node_viewer -.->|"dispatches plugin"| node_model3d
node_viewer -.->|"dispatches plugin"| node_office
node_viewer -.->|"dispatches plugin"| node_cad
node_viewer -.->|"dispatches fallback"| node_fallback
node_office -->|"parses legacy Word"| node_legacyword
node_office -->|"parses legacy slides"| node_legacydeck
node_office -->|"parses WordML"| node_wordml
node_cad -->|"uses parsers"| node_cadformats
node_image -->|"uses utilities"| node_dom
node_archive -->|"reads file data"| node_utils
node_pdf -->|"uses zoom helper"| node_utils
node_asset -->|"renders PDF asset"| node_pdf

click node_react "https://github.com/xushanpei/open-file-viewer/blob/main/packages/react/src/index.tsx"
click node_vue "https://github.com/xushanpei/open-file-viewer/blob/main/packages/vue/src/index.ts"
click node_svelte "https://github.com/xushanpei/open-file-viewer/blob/main/packages/svelte/src/OpenFileViewer.svelte"
click node_viewer "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/viewer.ts"
click node_support "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/support.ts"
click node_detect "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/detect.ts"
click node_dom "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/dom.ts"
click node_messages "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/messages.ts"
click node_image "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/image.ts"
click node_pdf "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/pdf.ts"
click node_asset "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/asset.ts"
click node_media "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/audio.ts"
click node_text "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/text.ts"
click node_archive "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/archive.ts"
click node_email "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/email.ts"
click node_drawing "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/drawing.ts"
click node_gis "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/gis.ts"
click node_model3d "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/model3d.ts"
click node_office "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/office.ts"
click node_legacyword "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/msdoc.ts"
click node_legacydeck "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/msppt.ts"
click node_wordml "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/wordml.ts"
click node_cad "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/cad.ts"
click node_cadformats "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/cad-dwg.ts"
click node_fallback "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/fallback.ts"
click node_utils "https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/utils.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_react,node_vue,node_svelte toneBlue
class node_viewer,node_support toneAmber
class node_image,node_pdf,node_asset,node_media,node_text,node_archive,node_email,node_drawing,node_gis,node_model3d,node_fallback toneMint
class node_office,node_legacyword,node_legacydeck,node_wordml,node_cad,node_cadformats toneRose
class node_detect,node_dom,node_messages,node_utils,node_host toneIndigo
```

## Components

### Host integrations

- [React adapter](https://github.com/xushanpei/open-file-viewer/blob/main/packages/react/src/index.tsx): `packages/react/src/index.tsx`
- [Vue adapter](https://github.com/xushanpei/open-file-viewer/blob/main/packages/vue/src/index.ts): `packages/vue/src/index.ts`
- [Svelte adapter](https://github.com/xushanpei/open-file-viewer/blob/main/packages/svelte/src/OpenFileViewer.svelte): `packages/svelte/src/OpenFileViewer.svelte`

### Viewer runtime

- [Viewer and queue](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/viewer.ts): `packages/core/src/viewer.ts`
- [Support check](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/support.ts): `packages/core/src/support.ts`

### Format plugins

- [Image preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/image.ts): `packages/core/src/plugins/image.ts`
- [PDF preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/pdf.ts): `packages/core/src/plugins/pdf.ts`
- [Data and assets](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/asset.ts): `packages/core/src/plugins/asset.ts`
- [Audio and video](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/audio.ts): `packages/core/src/plugins/audio.ts`
- [Text and code](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/text.ts): `packages/core/src/plugins/text.ts`
- [Archive preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/archive.ts): `packages/core/src/plugins/archive.ts`
- [Email preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/email.ts): `packages/core/src/plugins/email.ts`
- [Drawing preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/drawing.ts): `packages/core/src/plugins/drawing.ts`
- [GIS preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/gis.ts): `packages/core/src/plugins/gis.ts`
- [3D preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/model3d.ts): `packages/core/src/plugins/model3d.ts`
- [Download fallback](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/fallback.ts): `packages/core/src/plugins/fallback.ts`

### Office and CAD

- [Office preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/office.ts): `packages/core/src/plugins/office.ts`
- [Legacy Word parser](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/msdoc.ts): `packages/core/src/plugins/msdoc.ts`
- [Legacy PowerPoint parser](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/msppt.ts): `packages/core/src/plugins/msppt.ts`
- [WordML parser](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/wordml.ts): `packages/core/src/plugins/wordml.ts`
- [CAD preview](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/cad.ts): `packages/core/src/plugins/cad.ts`
- [DWG and OASIS parsers](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/cad-dwg.ts): `packages/core/src/plugins/cad-dwg.ts`

### Shared services

- [File normalization](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/detect.ts): `packages/core/src/detect.ts`
- [DOM utilities](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/dom.ts): `packages/core/src/dom.ts`
- [Messages and locale](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/messages.ts): `packages/core/src/messages.ts`
- [Plugin utilities](https://github.com/xushanpei/open-file-viewer/blob/main/packages/core/src/plugins/utils.ts): `packages/core/src/plugins/utils.ts`

### Other components

- **Web application**

## Connections

- Web application → Viewer and queue: configures
- Web application → React adapter: uses
- Web application → Vue adapter: uses
- Web application → Svelte adapter: uses
- React adapter → Viewer and queue: wraps (evidence: `packages/react/src/index.tsx`)
- Vue adapter → Viewer and queue: wraps (evidence: `packages/vue/src/index.ts`)
- Svelte adapter → Viewer and queue: creates (evidence: `packages/svelte/src/OpenFileViewer.svelte`)
- Viewer and queue → File normalization: normalizes files (evidence: `packages/core/src/viewer.ts`)
- Support check → File normalization: normalizes source (evidence: `packages/core/src/support.ts`)
- Viewer and queue → DOM utilities: resolves container (evidence: `packages/core/src/viewer.ts`)
- Viewer and queue → Messages and locale: resolves locale (evidence: `packages/core/src/viewer.ts`)
- Viewer and queue → Image preview: dispatches plugin
- Viewer and queue → PDF preview: dispatches plugin
- Viewer and queue → Data and assets: dispatches plugin
- Viewer and queue → Audio and video: dispatches plugins
- Viewer and queue → Text and code: dispatches plugin
- Viewer and queue → Archive preview: dispatches plugin
- Viewer and queue → Email preview: dispatches plugin
- Viewer and queue → Drawing preview: dispatches plugin
- Viewer and queue → GIS preview: dispatches plugin
- Viewer and queue → 3D preview: dispatches plugin
- Viewer and queue → Office preview: dispatches plugin
- Viewer and queue → CAD preview: dispatches plugin
- Viewer and queue → Download fallback: dispatches fallback (evidence: `packages/core/src/viewer.ts`)
- Office preview → Legacy Word parser: parses legacy Word (evidence: `packages/core/src/plugins/office.ts`)
- Office preview → Legacy PowerPoint parser: parses legacy slides (evidence: `packages/core/src/plugins/office.ts`)
- Office preview → WordML parser: parses WordML (evidence: `packages/core/src/plugins/office.ts`)
- CAD preview → DWG and OASIS parsers: uses parsers (evidence: `packages/core/src/plugins/cad.ts`)
- Image preview → DOM utilities: uses utilities (evidence: `packages/core/src/plugins/image.ts`)
- Archive preview → Plugin utilities: reads file data (evidence: `packages/core/src/plugins/archive.ts`)
- PDF preview → Plugin utilities: uses zoom helper (evidence: `packages/core/src/plugins/pdf.ts`)
- Data and assets → PDF preview: renders PDF asset (evidence: `packages/core/src/plugins/asset.ts`)
