Interface: StandardFieldDefinition
Makaio Framework / contracts / StandardFieldDefinition
Interface: StandardFieldDefinition
Section titled “Interface: StandardFieldDefinition”Defined in: ../../../packages/contracts/src/shared/ui-config.ts:230
Field definition for builtin field types.
Extends
Section titled “Extends”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.
Inherited from
Section titled “Inherited from”BaseFieldDefinition.defaultValue
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).
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”BaseFieldDefinition.description
disabled?
Section titled “disabled?”
optionaldisabled?:boolean
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:226
Whether the field is disabled.
Inherited from
Section titled “Inherited from”key:
string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:204
Unique key for the field (used as form field name).
Inherited from
Section titled “Inherited from”label:
string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:206
Display label for the field.
Inherited from
Section titled “Inherited from”
optionalmax?:number
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:212
Maximum numeric value (for numeric fields, including the slider widget).
Inherited from
Section titled “Inherited from”
optionalmin?:number
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:210
Minimum numeric value (for numeric fields, including the slider widget).
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”placeholder?
Section titled “placeholder?”
optionalplaceholder?:string
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:216
Placeholder text for text-based inputs.
Inherited from
Section titled “Inherited from”BaseFieldDefinition.placeholder
required?
Section titled “required?”
optionalrequired?:boolean
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:220
Whether the field is required.
Inherited from
Section titled “Inherited from”
optionalstep?:number
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:214
Step increment for numeric fields, including the slider widget.
Inherited from
Section titled “Inherited from”type:
"number"|"boolean"|"array"|"text"|"select"|"password"
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:232
Type of input to render.
widget?
Section titled “widget?”
optionalwidget?:FieldWidget
Defined in: ../../../packages/contracts/src/shared/ui-config.ts:234
Custom widget for specialized rendering (e.g., tags for arrays).