Vue SDK
@open-pencil/vue gibt es, damit OpenPencil mehr als eine eigenständige Design-App sein kann.
Das Ziel ist es, OpenPencil zu einem Toolkit zu machen, das Sie in andere Produkte, interne Tools und workflow-spezifische Editoren einbetten können — nicht nur als einzelne Standard-UI.
Die OpenPencil-App ist eine mögliche Zusammensetzung dieses Toolkits. Das SDK ist der Weg, eine andere zu bauen.
Es bietet Ihnen:
- injizierten Editor-Kontext
- CanvasKit-gestütztes Canvas-Rendering
- Composables für Auswahl, Befehle, Menü, Eigenschafts-Panel und Variablen
- headless strukturelle Primitive wie
PageListRoot,PropertyListRootundToolbarRoot - eingebaute i18n-Primitive für Menüs, Panels, Dialoge und benutzerdefinierte Locale-Picker
Hier beginnen
Warum das SDK existiert
Verschiedene Produkte und Teams benötigen unterschiedliche Bearbeitungsoberflächen.
Manchmal möchten Sie einen vollständigen Design-Editor. Manchmal möchten Sie einen fokussierten Canvas innerhalb einer anderen App. Manchmal benötigen Sie ein internes Workflow-Tool, einen Template-Editor oder eine KI-gestützte Bearbeitungsoberfläche für einen speziellen Anwendungsfall.
Das SDK ist die Schicht, die all das ermöglicht.
Designprinzipien
- Headless-First: Logik und Struktur, kein App-Styling
- Composable statt Wrapper: Composables verwenden, wenn keine bedeutungsvolle strukturelle Koordination erforderlich ist
- Bewusste öffentliche API: stabile Exporte aus
packages/vue/src/index.ts - Framework-bewusst: Vue-Integration über
@open-pencil/core
Das Paket verstehen
Das SDK hat zwei Hauptschichten:
- Composables für Editor-Zustand und Aktionen
- Primitive für bedeutungsvolle UI-Struktur
Wenn Sie nur Editor-Zustand und Aktionen benötigen, beginnen Sie mit Composables. Wenn Sie wiederverwendbare Editor-UI-Bausteine erstellen, beginnen Sie mit Primitiven.