Interface: BaseFieldDefinition
Makaio Framework / contracts/shared / BaseFieldDefinition
Interface: BaseFieldDefinition
Section titled “Interface: BaseFieldDefinition”Defined in: ../../../packages/contracts/src/shared/ui-config.ts:202
Shared properties for all form field definitions.
This interface provides the seam for extensible form generation. Fields can be generated from JSON Schema, hardcoded registries, or any other source that can produce this structure.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”defaultValue?
Section titled “defaultValue?”
optionaldefaultValue?:unknown
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:224
Default value for the field.
delimiter?
Section titled “delimiter?”
optionaldelimiter?:string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:208
Delimiter for array-type fields (default varies by widget).
description?
Section titled “description?”
optionaldescription?:string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:218
Help text/description shown below the input, including mapped override help text.
disabled?
Section titled “disabled?”
optionaldisabled?:boolean
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:226
Whether the field is disabled.
key:
string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:204
Unique key for the field (used as form field name).
label:
string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:206
Display label for the field.
optionalmax?:number
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:212
Maximum numeric value (for numeric fields, including the slider widget).
optionalmin?:number
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:210
Minimum numeric value (for numeric fields, including the slider widget).
options?
Section titled “options?”
optionaloptions?:object[]
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:222
Options for select-type fields.
label:
string
The display label for this option.
value:
string
The value to be stored when this option is selected.
placeholder?
Section titled “placeholder?”
optionalplaceholder?:string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:216
Placeholder text for text-based inputs.
required?
Section titled “required?”
optionalrequired?:boolean
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:220
Whether the field is required.
optionalstep?:number
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:214
Step increment for numeric fields, including the slider widget.