Type Alias: FieldDefinition

Makaio Framework

---

Makaio Framework / contracts / FieldDefinition

Type Alias: FieldDefinition

FieldDefinition = StandardFieldDefinition | CustomFieldDefinition

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

Definition for a form field.

Builtin field types may omit widget and fall back to their type renderer. Custom field types must provide a registered widget so render-time lookup never falls back to the literal 'custom' type.

Type Composition

• FieldDefinition
  • StandardFieldDefinition | CustomFieldDefinition
    • StandardFieldDefinition
      • BaseFieldDefinition
    • CustomFieldDefinition
      • BaseFieldDefinition

Resolved Shape

type FieldDefinition = {
  type: 'number' | 'boolean' | 'array' | 'custom' | 'text' | 'password' | 'select';
  widget?: FieldWidget | undefined;
  key: string;
  label: string;
  delimiter?: string | undefined;
  min?: number | undefined;
  max?: number | undefined;
  step?: number | undefined;
  placeholder?: string | undefined;
  description?: string | undefined;
  required?: boolean | undefined;
  options?: Array<{ value: string; label: string; }> | undefined;
  defaultValue?: unknown;
  disabled?: boolean | undefined;
};