Interface FieldConfig

Resolved metadata for a single field, used by the list, form and detail renderers and by the filter bar.

interface FieldConfig {
    autocomplete?: "text" | "token" | "email" | "phone";
    defaultValue?: any;
    description: string;
    discriminatorProperty?: string;
    editAs?: string;
    enumValues?: string[];
    filterable: boolean;
    fk?: FKFieldConfig;
    format?: string;
    hidden: { detail?: boolean; form?: boolean; list?: boolean };
    inlineDisplayFormat?: string;
    isArray: boolean;
    label: string;
    name: string;
    oneOfOptions?: OneOfOption[];
    order: number;
    readOnly: boolean;
    refSchema?: string;
    required: boolean;
    sortable: boolean;
    type: string;
    uiType?: string;
    upload?: { type: string; url: string };
    uploadUrl?: string;
}

Properties

autocomplete? defaultValue? description discriminatorProperty? editAs? enumValues? filterable fk? format? hidden inlineDisplayFormat? isArray label name oneOfOptions? order readOnly refSchema? required sortable type uiType? upload? uploadUrl?

Properties

Optionalautocomplete

autocomplete?: "text" | "token" | "email" | "phone"

Server-side filter widget hint (text/token/email/phone).

OptionaldefaultValue

defaultValue?: any

Schema-level default used to seed create-form state.

description

description: string

Description, if provided in the schema.

OptionaldiscriminatorProperty

discriminatorProperty?: string

Property name that discriminates a oneOf field.

OptionaleditAs

editAs?: string

x-edit-as: date - edit a date-time field with a plain date input; submits midnight.

OptionalenumValues

enumValues?: string[]

Allowed values for enum fields.

filterable

filterable: boolean

Whether the field can be filtered (x-filterable).

Optionalfk

fk?: FKFieldConfig

Foreign-key relationship, if this field references another resource.

Optionalformat

format?: string

OpenAPI format ("date", "date-time", "email", ...).

hidden

hidden: { detail?: boolean; form?: boolean; list?: boolean }

Where the field is hidden.

OptionalinlineDisplayFormat

inlineDisplayFormat?: string

Display template for inline references.

isArray

isArray: boolean

Whether the value is an array.

label

label: string

Display label (x-label).

name

name: string

Property name in the schema.

OptionaloneOfOptions

oneOfOptions?: OneOfOption[]

Branches for discriminated-union fields.

order

order: number

Sort order (x-order).

readOnly

readOnly: boolean

Whether the field is read-only.

OptionalrefSchema

refSchema?: string

Schema name for inline (non-FK) object references.

required

required: boolean

Whether the field is required.

sortable

sortable: boolean

Whether the list can be sorted by this field.

type

type: string

OpenAPI type ("string", "integer", "object", ...).

OptionaluiType

uiType?: string

UI-type override such as "currency" or "image".

Optionalupload

upload?: { type: string; url: string }

Parsed upload config ({ type, url }).

OptionaluploadUrl

uploadUrl?: string

Upload endpoint for file/image fields.

Settings

Member Visibility

On This Page

Properties