API Reference

Overview

This reference follows the package exports map in package.json. Use subpath imports; the package root only re-exports useTranslation.

SectionImport prefixScope
Public hooks@verbb/plugin-kit-react/hooksuseTranslation, useKeyboardShortcuts
Public utilities@verbb/plugin-kit-react/utilscn, schema helpers, portals, host bridge, validation, + re-exported @verbb/plugin-kit
Public typesSame as hooks/utils/formsKey TS types consumers rely on
Form APIs@verbb/plugin-kit-react/formsOverall forms export surface
SchemaForm API@verbb/plugin-kit-react/formsEngine hook, engine component, lifecycle surface
SchemaForm Registry@verbb/plugin-kit-react/formsRegister custom $field and $cmp types
React app APIs@verbb/plugin-kit-react/utilsconfigurePluginKitReact, createCraftHostBridge, Craft bootstrap patterns
Styling APIsCSS + buildstyle.css, Tailwind/shadow notes

Stability

The components and forms surfaces are evolving with Formie and sibling plugins; treat registry keys and schema node shapes as contracts you share with your PHP layer. configurePluginKitReact and createCraftHostBridge are relatively 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: May 22, 2026, 6:53 PM