# kozakdenys/qr-code-styling architecture

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

- Interactive diagram: https://gitdiagram.com/kozakdenys/qr-code-styling
- Repository: https://github.com/kozakdenys/qr-code-styling
- Video tour (about a minute): https://gitdiagram.com/kozakdenys/qr-code-styling/video

## Overview

QR Code Styling is a JavaScript library for generating styled QR codes with optional center images, SVG or canvas output, and export/download support. The main workflow is to construct or update a QRCodeStyling instance with data and options, encode the data, render the QR matrix with styling, then append or export the result. The README also documents extensions. The sampled source shows SVG rendering and export paths; unsampled internals limit detail about some canvas and image-rendering links.

Main entry points: [`src/core/QRCodeStyling.ts`](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts) (QR instance), [`src/core/QRSVG.ts`](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRSVG.ts) (SVG renderer), [`src/index.ts`](https://github.com/kozakdenys/qr-code-styling/blob/master/src/index.ts) (Public exports), [`src/tools/downloadURI.ts`](https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/downloadURI.ts) (Download URI)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Library API"]
  node_qrstyling["QR instance<br/>[QRCodeStyling.ts]"]
  node_exports["Public exports<br/>[index.ts]"]
  node_options["Defaults and options<br/>[QROptions.ts]"]
  node_raw["Raw data export<br/>[QRCodeStyling.ts]"]
  node_download["File download<br/>[QRCodeStyling.ts]"]
  node_extension["SVG extension<br/>[index.ts]"]
end

subgraph group_render["QR Rendering"]
  node_qrcode["QR encoding"]
  node_svg["SVG renderer<br/>[QRSVG.ts]"]
  node_dots["Dot figures<br/>[QRDot.ts]"]
  node_cornerdots["Corner dot figures<br/>[QRCornerDot.ts]"]
  node_cornersquares["Corner square figures<br/>[QRCornerSquare.ts]"]
  node_canvas["Canvas output<br/>[QRCodeStyling.ts]"]
end

subgraph group_tools["Options and Export"]
  node_sanitize["Option sanitizing<br/>[sanitizeOptions.ts]"]
  node_merge["Option merging<br/>[merge.ts]"]
  node_mode["Mode selection<br/>[getMode.ts]"]
  node_imagecalc["Logo sizing"]
  node_dataurl["Image data URL<br/>[toDataUrl.ts]"]
  node_downloaduri["Download URI<br/>[downloadURI.ts]"]
end

node_user(("Application"))
node_qrcodegen["qrcode-generator"]
node_host["DOM container"]
node_file["Saved file"]

node_user -->|"imports API"| node_exports
node_user -->|"sets data/options"| node_qrstyling
node_exports -->|"exports class"| node_qrstyling
node_qrstyling -->|"loads defaults"| node_options
node_qrstyling -->|"merges options"| node_merge
node_qrstyling -->|"sanitizes options"| node_sanitize
node_qrstyling -->|"selects mode"| node_mode
node_qrstyling -->|"encodes data"| node_qrcodegen
node_qrcodegen -->|"returns QR matrix"| node_qrstyling
node_qrstyling -->|"renders SVG"| node_svg
node_svg -->|"draws modules"| node_dots
node_svg -->|"draws corner dots"| node_cornerdots
node_svg -->|"draws corner squares"| node_cornersquares
node_svg -->|"sizes logo area"| node_imagecalc
node_svg -->|"converts logo"| node_dataurl
node_qrstyling -->|"renders canvas"| node_canvas
node_qrstyling -->|"applies extension"| node_extension
node_qrstyling -->|"appends output"| node_host
node_user -->|"requests export"| node_raw
node_raw -->|"returns raw data"| node_file
node_user -->|"requests download"| node_download
node_download -->|"starts download"| node_downloaduri
node_downloaduri -->|"saves file"| node_file

click node_qrstyling "https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts"
click node_exports "https://github.com/kozakdenys/qr-code-styling/blob/master/src/index.ts"
click node_options "https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QROptions.ts"
click node_sanitize "https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/sanitizeOptions.ts"
click node_merge "https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/merge.ts"
click node_mode "https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/getMode.ts"
click node_svg "https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRSVG.ts"
click node_dots "https://github.com/kozakdenys/qr-code-styling/blob/master/src/figures/dot/QRDot.ts"
click node_cornerdots "https://github.com/kozakdenys/qr-code-styling/blob/master/src/figures/cornerDot/QRCornerDot.ts"
click node_cornersquares "https://github.com/kozakdenys/qr-code-styling/blob/master/src/figures/cornerSquare/QRCornerSquare.ts"
click node_imagecalc "https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/calculateImageSize.ts"
click node_dataurl "https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/toDataUrl.ts"
click node_canvas "https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts"
click node_raw "https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts"
click node_download "https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts"
click node_downloaduri "https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/downloadURI.ts"
click node_extension "https://github.com/kozakdenys/qr-code-styling/blob/master/src/types/index.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_qrstyling,node_exports,node_options,node_raw,node_download,node_extension toneBlue
class node_qrcode,node_svg,node_dots,node_cornerdots,node_cornersquares,node_canvas toneAmber
class node_sanitize,node_merge,node_mode,node_imagecalc,node_dataurl,node_downloaduri toneMint
class node_user,node_qrcodegen,node_host,node_file toneIndigo
```

## Components

### Library API

- [QR instance](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts): `src/core/QRCodeStyling.ts`
- [Public exports](https://github.com/kozakdenys/qr-code-styling/blob/master/src/index.ts): `src/index.ts`
- [Defaults and options](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QROptions.ts): `src/core/QROptions.ts`
- [Raw data export](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts): `src/core/QRCodeStyling.ts`
- [File download](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts): `src/core/QRCodeStyling.ts`
- [SVG extension](https://github.com/kozakdenys/qr-code-styling/blob/master/src/types/index.ts): `src/types/index.ts`

### QR Rendering

- **QR encoding**
- [SVG renderer](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRSVG.ts): `src/core/QRSVG.ts`
- [Dot figures](https://github.com/kozakdenys/qr-code-styling/blob/master/src/figures/dot/QRDot.ts): `src/figures/dot/QRDot.ts`
- [Corner dot figures](https://github.com/kozakdenys/qr-code-styling/blob/master/src/figures/cornerDot/QRCornerDot.ts): `src/figures/cornerDot/QRCornerDot.ts`
- [Corner square figures](https://github.com/kozakdenys/qr-code-styling/blob/master/src/figures/cornerSquare/QRCornerSquare.ts): `src/figures/cornerSquare/QRCornerSquare.ts`
- [Canvas output](https://github.com/kozakdenys/qr-code-styling/blob/master/src/core/QRCodeStyling.ts): `src/core/QRCodeStyling.ts`

### Options and Export

- [Option sanitizing](https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/sanitizeOptions.ts): `src/tools/sanitizeOptions.ts`
- [Option merging](https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/merge.ts): `src/tools/merge.ts`
- [Mode selection](https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/getMode.ts): `src/tools/getMode.ts`
- [Logo sizing](https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/calculateImageSize.ts): `src/tools/calculateImageSize.ts`
- [Image data URL](https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/toDataUrl.ts): `src/tools/toDataUrl.ts`
- [Download URI](https://github.com/kozakdenys/qr-code-styling/blob/master/src/tools/downloadURI.ts): `src/tools/downloadURI.ts`

### Other components

- **Application**
- **qrcode-generator**
- **DOM container**
- **Saved file**

## Connections

- Application → Public exports: imports API
- Application → QR instance: sets data/options
- Public exports → QR instance: exports class
- QR instance → Defaults and options: loads defaults
- QR instance → Option merging: merges options
- QR instance → Option sanitizing: sanitizes options
- QR instance → Mode selection: selects mode
- QR instance → qrcode-generator: encodes data
- qrcode-generator → QR instance: returns QR matrix
- QR instance → SVG renderer: renders SVG
- SVG renderer → Dot figures: draws modules
- SVG renderer → Corner dot figures: draws corner dots
- SVG renderer → Corner square figures: draws corner squares
- SVG renderer → Logo sizing: sizes logo area
- SVG renderer → Image data URL: converts logo
- QR instance → Canvas output: renders canvas
- QR instance → SVG extension: applies extension
- QR instance → DOM container: appends output
- Application → Raw data export: requests export
- Raw data export → Saved file: returns raw data
- Application → File download: requests download
- File download → Download URI: starts download
- Download URI → Saved file: saves file
