Package overview
The supported entrypoints and the capability each package owns.
Install only the packages that own capabilities your product uses.
| Import | Contract |
|---|---|
@lupinum/board-core | Framework-agnostic engine, types, commands, math, events, and JSON Canvas |
@lupinum/vue-board | BoardRoot, board components, composables, and styles |
@lupinum/vue-board/minimap | Minimap composable and renderer |
@lupinum/board-connections | Headless edge plugin, routing, and geometry |
@lupinum/board-connections/vue | Connection rendering and interaction |
@lupinum/board-history | Undo and redo plugin |
@lupinum/nuxt-board | Nuxt registration |
@lupinum/board-core/internal is published so separately versioned first-party packages can share an ABI. Applications should not depend on it.
All packages are ESM and target Node 20.19 or newer. Vue-facing packages require Vue 3.5.
Use the pages in this section for exact signatures, return values, events, and failures.
Runtime export index
Core exports BOARD_COLOR_PRESETS, BoardError, BoardInputError,
BoardNotFoundError, BoardConflictError, CommandBlockedError,
BoardDestroyedError, createBoardEngine, asNodeId, asEdgeId, clamp,
boundsIntersect, getBoundsFromPoints, getVisibleBounds,
getSelectionNodes, getSelectionBounds, toggleIds, colorForPreset, and
isBoardColorPreset.
Connections exports EDGE_COLOR_PRESETS, connectionsPlugin,
buildArcRoute, buildConnectionRoute, getVisibleEdges,
resolveAnchorPoint, resolveAutoAnchorSide, resolveConnectionEndpoint,
resolveEdgeRenderState, resolveFloatingEndpoint, edgeEndsForDirectionality,
presetForColor, resolvePresetColor, and its own colorForPreset helper.