Built-in Schema Fields

VariablePickerField

Basic Usage

Use VariablePickerField when the schema needs token-aware plain-text input.

Registry

  • Key: variablePicker
  • Module: src/forms/fields/VariablePickerField.tsx

Role in SchemaForm

Inserts variable tokens into content (email bodies, notifications, etc.) using TipTap variable picker UI. Category lists can be supplied through VariableCategoriesProvider / useVariableCategoriesContext (src/forms/contexts/VariableCategoriesContext.tsx).

Integration

Wrap the engine (or app root) with:

tsx
import { VariableCategoriesProvider } from '@verbb/plugin-kit-react/forms';

<VariableCategoriesProvider value={{ getVariableCategories, variableCategoryLabels, variableCategoryOrder, variableTransformerRegistry }}>
  <SchemaFormEngine form={form} />
</VariableCategoriesProvider>

Example schema

json
{
  "$field": "variablePicker",
  "name": "subject",
  "label": "Subject"
}