Vue SDK
@open-pencil/vue istnieje po to, by OpenPencil mógł być czymś więcej niż samodzielną aplikacją do projektowania.
Celem jest uczynienie OpenPencil zestawem narzędzi, który można wbudować w inne produkty, narzędzia wewnętrzne i edytory dopasowane do konkretnych przepływów pracy — a nie tylko jednym domyślnym interfejsem.
Aplikacja OpenPencil jest jedną z kompozycji tego zestawu. SDK to sposób na zbudowanie innej.
Udostępnia:
- wstrzykiwany kontekst edytora
- renderowanie canvasu oparte na CanvasKit
- kompozyty selekcji, poleceń, menu, panelu właściwości i zmiennych
- bezstanowe prymitywy strukturalne jak
PageListRoot,PropertyListRootiToolbarRoot - wbudowane prymitywy i18n dla menu, paneli, okien dialogowych i niestandardowych selektorów języka
Zacznij tutaj
Dlaczego SDK istnieje
Różne produkty i zespoły potrzebują różnych powierzchni edycji.
Czasem chcesz pełny edytor projektowania. Czasem chcesz skupiony kanvas wewnątrz innej aplikacji. Czasem potrzebujesz wewnętrznego narzędzia do przepływu pracy, edytora szablonów lub powierzchni edycji wspomaganej AI zbudowanej wokół wąskiego przypadku użycia.
SDK to warstwa, która to umożliwia.
Zasady projektowania
- Headless na pierwszym miejscu: logika i struktura, bez stylowania aplikacji
- Kompozyty zamiast opakowań: używaj kompozytów, gdy nie ma znaczącej koordynacji strukturalnej
- Przemyślane publiczne API: stabilne eksporty z
packages/vue/src/index.ts - Świadomość frameworka: integracja Vue nad
@open-pencil/core
Jak myśleć o pakiecie
SDK ma dwie główne warstwy:
- Kompozyty dla stanu edytora i akcji
- Prymitywy dla znaczącej struktury UI
Jeśli potrzebujesz tylko stanu edytora i akcji, zacznij od kompozytów. Jeśli budujesz wielokrotnie używalne bloki budulcowe UI edytora, zacznij od prymitywów.