interface

PluginFieldRegistration

Helper return type that preserves saved-value and write-value types for generated Go/admin compatibility checks. Let TypeScript infer it from your registration; annotating everything as RegisteredPluginField would lose this information.

Properties

PropertyTypeDescription
typeTypeThe type value.
__@valueContract@2523{ value: (value: Value) => Value; input: (value: Input) => Input; }The __@valueContract@2523 value.
fieldTypestringThe fieldType value.
componentComponent<never, {}, string>The component value.
decodeConfig(field: SchemaField) => unknownThe decodeConfig value.
decodeValue(value: unknown) => unknownThe decodeValue value.
decodeInput(value: unknown) => unknownThe decodeInput value.
decodeFormValue(value: unknown) => unknownThe decodeFormValue value.
__@registration@2502trueThe __@registration@2502 value.

Full signature

interface PluginFieldRegistration<Value, Input = Value, Type extends FieldType = FieldType> { ... }

Source packages/plugin/src/index.ts:16

Methods