@kivcode/vue
Documentación de Kiv
Kiv es un motor de edición visual headless, JSON-driven y basado en plugins — el objetivo es un editor visuaVl reutilizable (estilo Elementor/Framer/Webflow) que cualquier aplicación pueda integrar sobre su propio contenido, sin acoplarse a un framework de UI específico más allá de Vue 3 (React planeado a futuro).
Esta carpeta es la fuente de verdad para usar Kiv fuera de este monorepo — en cualquier proyecto nuevo o existente.
Índice
| Documento | Para qué sirve | Estado |
|---|---|---|
| Instalación | Cómo instalar Kiv desde cero (monorepo local o futuro paquete npm publicado). | ✅ Escrito |
| Arquitectura | Cómo está organizado internamente — capas, flujo de dependencias, reglas invariantes. | ✅ Escrito |
| Migración | Cómo integrar Kiv en un proyecto existente sin perder compatibilidad con su contenido actual — patrón de adaptadores. | ✅ Escrito |
| Engine | Cómo funciona @kivcode/engine — document model, registry, schema de campos, historial, plugins. |
✅ Escrito |
| Editor | Cómo extender @kivcode/vue-editor — extension points, controles de campo custom, paneles. |
✅ Escrito |
| Crear un Node | Guía completa paso a paso para definir un nodo nuevo en @kivcode/nodes. |
✅ Escrito |
| Crear un control de Inspector | Guía completa para un control de campo custom (pluginControl). |
✅ Escrito |
| Sistema de Templates | Cómo crear templates de página completa y templates de bloque de contenido. | ✅ Escrito |
| API pública | Qué clases/funciones son la superficie pública de cada paquete. | ✅ Escrito |
| Eventos | Cómo reaccionar a cambios del editor vía el EventBus. |
✅ Escrito |
| Plugins | Cómo extender Kiv sin tocar el núcleo (createEngine({ plugins })). |
✅ Escrito |
| Buenas prácticas | Qué hacer y qué evitar al construir sobre Kiv. | ✅ Escrito |
| Ejemplos | Casos reales de uso, referenciando integraciones concretas. | ✅ Escrito |
| Troubleshooting | Problemas comunes y sus soluciones. | ✅ Escrito |
Convención de este directorio
- Cada documento es independiente y enlazable — no asumas que el lector leyó los anteriores en orden, pero sí puedes enlazar a ellos.
- Los documentos marcados 🚧 tienen ya su esqueleto (encabezados + alcance definido) — completarlos es la continuación natural de este trabajo.
- Cuando una integración concreta (por ejemplo, KMJK Events) descubra que Kiv le
falta algo, ese hallazgo se documenta en el repo de esa integración, no aquí
— este directorio describe a Kiv como producto, no las particularidades de un
consumidor específico. Ver
migration.mdpara el patrón que separa ambas cosas.
Related Packages
The Kiv visual page-builder editor UI — canvas, structure tree, inspector, drag...
Embeddable block-based page editor with a framework-agnostic iframe client and V...
Generic headless visual page builder and renderer for Vue 3 built on the Cocoar...
Dev-only Vite plugin: canvas ↔ source instrumentation, local editing API and the...
Version History
| Version | Released | Vue | License |
|---|---|---|---|
| 0.5.0 | ^3.5.0 | MIT | |
| 0.4.0 | ^3.5.0 | MIT | |
| 0.3.0 | ^3.5.0 | MIT | |
| 0.1.12 | ^3.5.0 | MIT | |
| 0.1.11 | ^3.5.0 | MIT | |
| 0.1.10 | ^3.5.0 | MIT | |
| 0.1.9 | ^3.5.0 | MIT | |
| 0.1.8 | ^3.5.0 | MIT | |
| 0.1.7 | ^3.5.0 | MIT | |
| 0.1.5 | ^3.5.0 | MIT | |
| 0.1.4 | ^3.5.0 | MIT | |
| 0.1.3 | ^3.5.0 | MIT | |
| 0.1.2 | ^3.5.0 | MIT | |
| 0.1.1 | ^3.5.0 | MIT | |
| 0.1.0 | ^3.5.0 | MIT |