How hades0050/nuxt-block-editor works
nuxt-block-editor is a Nuxt/Vue content-block editor. Users edit, fill, or read a grid of typed blocks; content is modeled and serialized, rendered through specialized editors, and form values can be collected or inserted via binding keys. The README documents rich text, nested tabs/tree content, media, canvas, localization, and code highlighting; unsampled UI details are represented at their exact enclosing paths. Edges cite shown calls or README statements; optional external-service behavior is not inferred.
Main entry points: index.vue Block editor · boxes Block renderers · Content.ts Content container · dataBinding.ts Data binding
Components 23
Editor runtime
- Block editor
src/runtime/components/block-editor/index.vue - Grid layout
src/runtime/composables/useGridstack.ts - Block controls
src/runtime/components/block-editor - Block renderers
src/runtime/components/block-editor/boxes - Block settings
src/runtime/components/block-editor/settings/BoxSettings.vue - Localization
src/runtime/composables/useEditorI18n.ts - Editor state
src/runtime/composables/useBlockEditor.ts
Content model
- Content container
src/model/content/Content.ts - Typed blocks
src/model/boxes - Block factory
src/model/factory/BoxFactory.ts - Nested items
src/model/items/TreeNode.ts - Templates
src/model/template
Forms and binding
- Form fields
src/model/form-values - Data binding
src/model/utils/dataBinding.ts - Field renderers
src/runtime/components/block-editor/boxes/data
Rich text and integrations
- Rich text
src/runtime/components/block-editor/boxes/content/text - Canvas drawing
src/runtime/components/block-editor/boxes/media/canvas - External service block
src/runtime/components/block-editor/boxes/structure/ExternalService.vue
Other components
- Editor user
- Gridstack
- Shiki
- TipTap
- Konva
Connections 26
- Editor user → Block editor: edits content
- Block editor → Editor state: uses state
src/runtime/components/block-editor/index.vue - Block editor → Grid layout: configures layout
src/runtime/components/block-editor/index.vue - Grid layout → Gridstack: initializes grid
src/runtime/composables/useGridstack.ts - Block editor → Block controls: renders controls
- Block editor → Block renderers: renders blocks
- Block editor → Block settings: offers settings
src/runtime/components/block-editor/settings/BoxSettings.vue - Block editor → Localization: provides locale
src/runtime/components/block-editor/index.vue - Block editor → Content container: edits model
- Content container → Block factory: deserializes via
src/model/content/Content.ts - Block factory → Typed blocks: creates types
src/model/factory/BoxFactory.ts - Content container → Typed blocks: stores blocks
src/model/content/Content.ts - Typed blocks → Nested items: holds nested items
src/model/boxes/BoxTabs.ts - Nested items → Content container: contains nested content
src/model/items/TreeNode.ts - Block renderers → Field renderers: renders form blocks
- Field renderers → Form fields: edits values
- Block editor → Data binding: exposes data actions
- Data binding → Content container: walks content
src/model/utils/dataBinding.ts - Data binding → Form fields: reads and fills
src/model/utils/dataBinding.ts - Block renderers → Rich text: renders text editor
- Rich text → TipTap: uses editor
- Block renderers → Canvas drawing: renders canvas
src/runtime/components/block-editor/boxes/media/canvas/useCanvasDraw.ts - Canvas drawing → Konva: draws with
- Block renderers → Shiki: highlights code
- Block renderers → Templates: supports template content
- Block renderers → External service block: renders service block