Interface: CustomFieldDefinition

Makaio Framework

Makaio Framework / contracts / CustomFieldDefinition

Interface: CustomFieldDefinition

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:238

Field definition for widgets that render through the custom field path.

Extends

BaseFieldDefinition

Properties

defaultValue?

optional defaultValue?: unknown

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:224

Default value for the field.

Inherited from

BaseFieldDefinition.defaultValue

delimiter?

optional delimiter?: string

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:208

Delimiter for array-type fields (default varies by widget).

Inherited from

BaseFieldDefinition.delimiter

description?

optional description?: string

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:218

Help text/description shown below the input, including mapped override help text.

Inherited from

BaseFieldDefinition.description

disabled?

optional disabled?: boolean

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:226

Whether the field is disabled.

Inherited from

BaseFieldDefinition.disabled

key

key: string

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:204

Unique key for the field (used as form field name).

Inherited from

BaseFieldDefinition.key

label

label: string

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:206

Display label for the field.

Inherited from

BaseFieldDefinition.label

max?

optional max?: number

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:212

Maximum numeric value (for numeric fields, including the slider widget).

Inherited from

BaseFieldDefinition.max

min?

optional min?: number

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:210

Minimum numeric value (for numeric fields, including the slider widget).

Inherited from

BaseFieldDefinition.min

options?

optional options?: object[]

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:222

Options for select-type fields.

label

label: string

The display label for this option.

value

value: string

The value to be stored when this option is selected.

Inherited from

BaseFieldDefinition.options

placeholder?

optional placeholder?: string

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:216

Placeholder text for text-based inputs.

Inherited from

BaseFieldDefinition.placeholder

required?

optional required?: boolean

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:220

Whether the field is required.

Inherited from

BaseFieldDefinition.required

step?

optional step?: number

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:214

Step increment for numeric fields, including the slider widget.

Inherited from

BaseFieldDefinition.step

type

type: "custom"

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:240

Custom fields always render through an explicit widget.

widget: FieldWidget

Defined in: ../../../packages/contracts/src/shared/ui-config.ts:242

Builtin or plugin-registered widget used to render the custom field.