Hex Core JS
    Preparing search index...

    Type Alias BaseFileUploadFieldProps<FV>

    BaseFileUploadFieldProps: BaseFieldProps<FV> & {
        autoFocus?: boolean;
        contentTypeFieldName: KeyWithValueType<FV, string>;
        display?: FieldDisplayFunction<FileFieldUploadFormValues>;
        id?: string;
        immediateValidation?: UseValidationDFAOptions<FileFieldValue>["immediateValidation"];
        keyFieldName: KeyWithValueType<FV, string>;
        label?: string;
        optional?: boolean;
        scheduledValidation?: UseValidationDFAOptions<FileFieldValue>["scheduledValidation"];
        scheduleValidationDelayMS?: UseValidationDFAOptions<FileFieldValue>["scheduleDelayMS"];
        sideEffect?: (k: string, ct: string) => void;
    }

    Generic props for a file upload field.

    Type Parameters

    Type Declaration

    • OptionalautoFocus?: boolean

      Indicates if the field should be auto-focused.

    • contentTypeFieldName: KeyWithValueType<FV, string>

      The field name of the file content-type field.

    • Optionaldisplay?: FieldDisplayFunction<FileFieldUploadFormValues>

      The display function for the field. Controls how to render the value when not editing. Useful for adding JSX elements or functionality to the displayed value (e.g. a link).

    • Optionalid?: string

      The id (HTML id) of the input.

    • OptionalimmediateValidation?: UseValidationDFAOptions<FileFieldValue>["immediateValidation"]

      Immediate validation function (syncronous).

    • keyFieldName: KeyWithValueType<FV, string>

      The field name of the file key field.

    • Optionallabel?: string

      The label of the field.

    • Optionaloptional?: boolean

      Indicates if the field is optional or required.

    • OptionalscheduledValidation?: UseValidationDFAOptions<FileFieldValue>["scheduledValidation"]

      Scheduled validation function (asyncronous).

    • OptionalscheduleValidationDelayMS?: UseValidationDFAOptions<FileFieldValue>["scheduleDelayMS"]

      The number of milliseconds to wait between a change and running scheduled validation.

    • OptionalsideEffect?: (k: string, ct: string) => void

      A side effect function to call when the value changes as a result of user interaction with this input, and not external updates to the field value.