# zikojs/ziko architecture

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

- Interactive diagram: https://gitdiagram.com/zikojs/ziko
- Repository: https://github.com/zikojs/ziko

## Overview

ZikoJS is a JavaScript UI-framework ecosystem: its core provides composable DOM primitives, full DOM APIs, hooks, components, and routing, alongside authoring, browser, and utility packages. A typical developer workflow starts with a generated project, whose file-based template routes pages into an application target. The README documents the framework layers and package capabilities; source excerpts confirm the template’s router entry point and selected DOM and storage behavior. Other package interactions are not assumed where implementation excerpts were unavailable.

Main entry points: [`packages/ziko/src/mini-dom/UIElement/index.js`](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/mini-dom/UIElement/index.js) (Mini DOM), [`packages/ziko/src/dom/UIElement/index.js`](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/dom/UIElement/index.js) (Full DOM elements), [`packages/create-ziko/templates/spa-js/src/main.js`](https://github.com/zikojs/ziko/blob/main/packages/create-ziko/templates/spa-js/src/main.js) (File-router template), [`packages/create-ziko/bin/index.js`](https://github.com/zikojs/ziko/blob/main/packages/create-ziko/bin/index.js) (Project generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App creation"]
  node_create["Project generator<br/>[index.js]"]
  node_template["File-router template<br/>[main.js]"]
end

subgraph group_core["Framework core"]
  node_router["File-based router<br/>[index.js]"]
  node_framework["Core framework API<br/>[index.js]"]
  node_minidom["Mini DOM<br/>[index.js]"]
  node_dom["Full DOM elements<br/>[index.js]"]
  node_ui_state[("UI registry<br/>[__ui__.js]")]
  node_props["DOM prop parsing<br/>[parse_props.js]"]
  node_hooks["Reactivity hooks<br/>[use-state.js]"]
  node_components["UI components"]
end

subgraph group_author["Authoring tools"]
  node_jsx["JSX compiler<br/>[index.js]"]
  node_html["HTML conversion<br/>[index.js]"]
  node_vite["Vite JSX plugin<br/>[index.js]"]
end

subgraph group_addons["Ecosystem packages"]
  node_browser["Browser utilities<br/>[use-storage.js]"]
  node_i18n["Translations<br/>[use-translate.js]"]
  node_math["Math utilities<br/>[index.js]"]
  node_ease["Easing functions<br/>[index.js]"]
  node_time["Time utilities<br/>[index.js]"]
end

node_developer(("Developer"))

node_developer -.->|"scaffolds project"| node_create
node_template -->|"creates routes"| node_router
node_dom -->|"extends primitives"| node_minidom
node_minidom -->|"registers elements"| node_ui_state
node_minidom -->|"parses props"| node_props
node_dom -->|"checks state values"| node_hooks

click node_create "https://github.com/zikojs/ziko/blob/main/packages/create-ziko/bin/index.js"
click node_template "https://github.com/zikojs/ziko/blob/main/packages/create-ziko/templates/spa-js/src/main.js"
click node_router "https://github.com/zikojs/ziko/blob/main/packages/ziko/src/router/file-based-router/index.js"
click node_framework "https://github.com/zikojs/ziko/blob/main/packages/ziko/src/index.js"
click node_minidom "https://github.com/zikojs/ziko/blob/main/packages/ziko/src/mini-dom/UIElement/index.js"
click node_dom "https://github.com/zikojs/ziko/blob/main/packages/ziko/src/dom/UIElement/index.js"
click node_ui_state "https://github.com/zikojs/ziko/blob/main/packages/ziko/src/__ziko__/__ui__.js"
click node_props "https://github.com/zikojs/ziko/blob/main/packages/ziko/src/dom/internal-utils/parse_props.js"
click node_hooks "https://github.com/zikojs/ziko/blob/main/packages/ziko/src/hooks/use-state.js"
click node_components "https://github.com/zikojs/ziko/tree/main/packages/ziko/src/components"
click node_jsx "https://github.com/zikojs/ziko/blob/main/packages/ziko-jsx/src/compiler/index.js"
click node_html "https://github.com/zikojs/ziko/blob/main/packages/ziko-html/src/html-to-ziko-ir/index.js"
click node_vite "https://github.com/zikojs/ziko/blob/main/packages/ziko-vite-plugin-jsx/src/index.js"
click node_browser "https://github.com/zikojs/ziko/blob/main/packages/ziko-browser/src/use-storage.js"
click node_i18n "https://github.com/zikojs/ziko/blob/main/packages/ziko-i18n/src/hooks/use-translate.js"
click node_math "https://github.com/zikojs/ziko/blob/main/packages/ziko-math/src/complex/index.js"
click node_ease "https://github.com/zikojs/ziko/blob/main/packages/ziko-ease/src/ease/index.js"
click node_time "https://github.com/zikojs/ziko/blob/main/packages/ziko-time/src/decorators/index.js"

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_create,node_template toneBlue
class node_router,node_framework,node_minidom,node_dom,node_ui_state,node_props,node_hooks,node_components toneAmber
class node_jsx,node_html,node_vite toneMint
class node_browser,node_i18n,node_math,node_ease,node_time toneRose
class node_developer toneIndigo
```

## Components

### App creation

- [Project generator](https://github.com/zikojs/ziko/blob/main/packages/create-ziko/bin/index.js): `packages/create-ziko/bin/index.js`
- [File-router template](https://github.com/zikojs/ziko/blob/main/packages/create-ziko/templates/spa-js/src/main.js): `packages/create-ziko/templates/spa-js/src/main.js`

### Framework core

- [File-based router](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/router/file-based-router/index.js): `packages/ziko/src/router/file-based-router/index.js`
- [Core framework API](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/index.js): `packages/ziko/src/index.js`
- [Mini DOM](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/mini-dom/UIElement/index.js): `packages/ziko/src/mini-dom/UIElement/index.js`
- [Full DOM elements](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/dom/UIElement/index.js): `packages/ziko/src/dom/UIElement/index.js`
- [UI registry](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/__ziko__/__ui__.js): `packages/ziko/src/__ziko__/__ui__.js`
- [DOM prop parsing](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/dom/internal-utils/parse_props.js): `packages/ziko/src/dom/internal-utils/parse_props.js`
- [Reactivity hooks](https://github.com/zikojs/ziko/blob/main/packages/ziko/src/hooks/use-state.js): `packages/ziko/src/hooks/use-state.js`
- [UI components](https://github.com/zikojs/ziko/tree/main/packages/ziko/src/components): `packages/ziko/src/components`

### Authoring tools

- [JSX compiler](https://github.com/zikojs/ziko/blob/main/packages/ziko-jsx/src/compiler/index.js): `packages/ziko-jsx/src/compiler/index.js`
- [HTML conversion](https://github.com/zikojs/ziko/blob/main/packages/ziko-html/src/html-to-ziko-ir/index.js): `packages/ziko-html/src/html-to-ziko-ir/index.js`
- [Vite JSX plugin](https://github.com/zikojs/ziko/blob/main/packages/ziko-vite-plugin-jsx/src/index.js): `packages/ziko-vite-plugin-jsx/src/index.js`

### Ecosystem packages

- [Browser utilities](https://github.com/zikojs/ziko/blob/main/packages/ziko-browser/src/use-storage.js): `packages/ziko-browser/src/use-storage.js`
- [Translations](https://github.com/zikojs/ziko/blob/main/packages/ziko-i18n/src/hooks/use-translate.js): `packages/ziko-i18n/src/hooks/use-translate.js`
- [Math utilities](https://github.com/zikojs/ziko/blob/main/packages/ziko-math/src/complex/index.js): `packages/ziko-math/src/complex/index.js`
- [Easing functions](https://github.com/zikojs/ziko/blob/main/packages/ziko-ease/src/ease/index.js): `packages/ziko-ease/src/ease/index.js`
- [Time utilities](https://github.com/zikojs/ziko/blob/main/packages/ziko-time/src/decorators/index.js): `packages/ziko-time/src/decorators/index.js`

### Other components

- **Developer**

## Connections

- Developer → Project generator: scaffolds project
- File-router template → File-based router: creates routes (evidence: `packages/create-ziko/templates/spa-js/src/main.js`)
- Full DOM elements → Mini DOM: extends primitives (evidence: `packages/ziko/src/dom/UIElement/index.js`)
- Mini DOM → UI registry: registers elements (evidence: `packages/ziko/src/mini-dom/UIElement/index.js`)
- Mini DOM → DOM prop parsing: parses props (evidence: `packages/ziko/src/mini-dom/UIElement/index.js`)
- Full DOM elements → Reactivity hooks: checks state values (evidence: `packages/ziko/src/dom/UIElement/index.js`)
