form-schema-runtime - v1.0.0
    Preparing search index...

    Interface FieldSchema

    Declarative field definition consumed by the runtime.

    Unknown type values are allowed only when a matching custom renderer is registered through CreateFormOptions.renderers.

    interface FieldSchema {
        defaultValue?: FieldValue;
        disabled?: boolean;
        helpText?: string;
        id?: string;
        label: string;
        max?: number;
        maxLength?: number;
        min?: number;
        minLength?: number;
        name: string;
        options?: FieldOption[];
        pattern?: string;
        placeholder?: string;
        readonly?: boolean;
        required?: boolean;
        type: FieldType;
        validationMessages?: Partial<Record<ValidationMessageKey, string>>;
        validators?: string[];
        visibleWhen?: VisibilityRule;
    }

    Hierarchy

    • BaseSchemaNode
      • FieldSchema
    Index

    Properties

    defaultValue? disabled? helpText? id? label max? maxLength? min? minLength? name options? pattern? placeholder? readonly? required? type validationMessages? validators? visibleWhen?

    Properties

    defaultValue?: FieldValue

    Default value used unless CreateFormOptions.initialValues overrides it.

    disabled?: boolean

    Whether the native control is disabled.

    helpText?: string

    Optional descriptive text referenced through aria-describedby.

    id?: string

    Optional stable identifier used when deriving DOM IDs and schema paths.

    label: string

    Visible label associated with the native control.

    max?: number

    Maximum numeric value for number-like fields.

    maxLength?: number

    Maximum string length for text-like values.

    min?: number

    Minimum numeric value for number-like fields.

    minLength?: number

    Minimum string length for text-like values.

    name: string

    Stable value key used in state, validation errors, and submission values.

    options?: FieldOption[]

    Options for select and radio fields.

    pattern?: string

    JavaScript regular expression source used for deterministic pattern validation.

    placeholder?: string

    Optional native placeholder text. Never used as a label replacement.

    readonly?: boolean

    Whether text-like native controls are readonly.

    required?: boolean

    Whether the field must contain a value before submission.

    type: FieldType

    Built-in field type or custom renderer type.

    validationMessages?: Partial<Record<ValidationMessageKey, string>>

    Optional field-specific messages for built-in validators.

    validators?: string[]

    Names of synchronous custom validators registered by the host application.

    visibleWhen?: VisibilityRule

    Declarative condition that controls whether this node is currently visible.

    Settings

    Member Visibility

    On This Page

    Properties