API Reference

Overview

This reference follows the package exports map in package.json. Use subpath imports; the package root re-exports components plus the app helpers (PluginKitProvider, mountShadowApp, …).

SectionImport prefixScope
App APIs@verbb/plugin-kit-vue, /appPluginKitProvider, mountShadowApp, configurePluginKitVue, createCraftHostBridge
Styling APIsCSS + buildstyle.css, Tailwind bridge files, vite-dev

Also exported (same roles as React; dedicated Vue API pages may follow):

Import prefixScope
@verbb/plugin-kit-vue/hooksuseTranslation
@verbb/plugin-kit-vue/utilscn, app config re-exports, host bridge, translation setters
@verbb/plugin-kit-vue/faultAppFaultProvider, boundary, fallback, watchdog, support bundle

SchemaForm APIs (@verbb/plugin-kit-vue/forms) live under Forms → API Reference (import the Vue package path in Vue apps):

Components import from @verbb/plugin-kit-vue/components — see the component docs.

Stability

The components and forms surfaces track the web-component and SchemaForm contracts. PluginKitProvider, configurePluginKitVue, and createCraftHostBridge are the stable integration points.

Versioning

Package version is SemVer on npm; breaking changes may land in 0.x without lengthy deprecation. Pin versions in plugin package.json when shipping CP bundles.

Edit this page
Last updated: Jul 19, 2026, 4:42 PM