Margarita form reference documentation
    Preparing search index...

    Interface MargaritaFormField<FP>

    interface MargaritaFormField<FP extends FieldParams = FieldParams> {
        __fields?: FP["fields"] extends object
            ? any[any][]
            : MFGF<FieldParams>[];
        __i18n?: FP["i18n"];
        __params?: FP;
        __value?: FP["value"];
        active?: UserDefinedStateResolver<MargaritaFormFieldState>;
        afterSubmit?: MargaritaFormResolver;
        attributes?: MargaritaFormFieldAttributes;
        beforeSubmit?: MargaritaFormResolver;
        config?: MargaritaFormConfig;
        context?: Context;
        currentLocale?: string | number;
        customStates?: (
            (
                state: StateManager<MFC>,
            ) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>
        )[];
        defaultValue?: FieldValue<ReplaceAny<FP["value"], unknown>>;
        disabled?: UserDefinedStateResolver<MargaritaFormFieldState>;
        dispatcher?: MargaritaFormResolver<FP["value"]> | NotFunction;
        editable?: UserDefinedStateResolver<MargaritaFormFieldState>;
        enabled?: UserDefinedStateResolver<MargaritaFormFieldState>;
        extensions?: ExtensionsArray;
        fieldModifiers?: FieldModifiers;
        fields?: FP["fields"] extends object
            ? FieldChild<any[any]>[]
            : FP["fields"] extends never ? never : MFGF<FieldParams>[];
        grouping?: CoreGetter<MargaritaFormGroupings>;
        handleLocalize?: MargaritaFormHandleLocalize<MFGF>;
        handleSubmit?:
            | string
            | MargaritaFormSubmitHandler<MFGF<{ value: FP["value"] }>>
            | MargaritaFormSubmitHandlers<MFGF<{ value: FP["value"] }>>;
        hidden?: UserDefinedStateResolver<MargaritaFormFieldState>;
        htmlTemplate?: string;
        i18n?: I18NField<FP["i18n"]>;
        inactive?: UserDefinedStateResolver<MargaritaFormFieldState>;
        initialValue?: FieldValue<ReplaceAny<FP["value"], unknown>>;
        isLocaleField?: boolean;
        locales?: Locales;
        localize?: boolean;
        managers?: Partial<Managers>;
        name: FP["name"] extends FieldName ? any[any] : FieldName;
        onChanges?: MargaritaFormResolver;
        onChildControlChanges?: MargaritaFormResolver;
        onCreate?: MargaritaFormResolver;
        onRemove?: MargaritaFormResolver;
        onStateChanges?: MargaritaFormResolver;
        onValueChanges?: MargaritaFormResolver;
        params?: MargaritaFormFieldParams;
        readOnly?: UserDefinedStateResolver<MargaritaFormFieldState>;
        resolvers?: MargaritaFormResolvers;
        startWith?: CoreGetter<StartWith>;
        storage?: boolean;
        transformer?: MargaritaFormResolver<FP["value"]>;
        validation?: MargaritaFormFieldValidation<FP["value"]>;
        validators?: MargaritaFormValidators;
        valueResolver?: MargaritaFormResolver<FP["value"]> | NotFunction;
        visible?: UserDefinedStateResolver<MargaritaFormFieldState>;
        wasLocalized?: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    __fields?: FP["fields"] extends object ? any[any][] : MFGF<FieldParams>[]
    __i18n?: FP["i18n"]
    __params?: FP
    __value?: FP["value"]
    active?: UserDefinedStateResolver<MargaritaFormFieldState>
    afterSubmit?: MargaritaFormResolver
    beforeSubmit?: MargaritaFormResolver
    context?: Context
    currentLocale?: string | number
    customStates?: (
        (
            state: StateManager<MFC>,
        ) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>
    )[]
    defaultValue?: FieldValue<ReplaceAny<FP["value"], unknown>>
    disabled?: UserDefinedStateResolver<MargaritaFormFieldState>
    dispatcher?: MargaritaFormResolver<FP["value"]> | NotFunction
    editable?: UserDefinedStateResolver<MargaritaFormFieldState>
    enabled?: UserDefinedStateResolver<MargaritaFormFieldState>
    extensions?: ExtensionsArray
    fieldModifiers?: FieldModifiers
    fields?: FP["fields"] extends object
        ? FieldChild<any[any]>[]
        : FP["fields"] extends never ? never : MFGF<FieldParams>[]
    grouping?: CoreGetter<MargaritaFormGroupings>
    handleLocalize?: MargaritaFormHandleLocalize<MFGF>
    handleSubmit?:
        | string
        | MargaritaFormSubmitHandler<MFGF<{ value: FP["value"] }>>
        | MargaritaFormSubmitHandlers<MFGF<{ value: FP["value"] }>>
    hidden?: UserDefinedStateResolver<MargaritaFormFieldState>
    htmlTemplate?: string
    i18n?: I18NField<FP["i18n"]>
    inactive?: UserDefinedStateResolver<MargaritaFormFieldState>
    initialValue?: FieldValue<ReplaceAny<FP["value"], unknown>>
    isLocaleField?: boolean
    locales?: Locales
    localize?: boolean
    managers?: Partial<Managers>
    name: FP["name"] extends FieldName ? any[any] : FieldName
    onChildControlChanges?: MargaritaFormResolver
    onStateChanges?: MargaritaFormResolver
    onValueChanges?: MargaritaFormResolver
    readOnly?: UserDefinedStateResolver<MargaritaFormFieldState>
    startWith?: CoreGetter<StartWith>
    storage?: boolean
    transformer?: MargaritaFormResolver<FP["value"]>
    validation?: MargaritaFormFieldValidation<FP["value"]>
    valueResolver?: MargaritaFormResolver<FP["value"]> | NotFunction
    visible?: UserDefinedStateResolver<MargaritaFormFieldState>
    wasLocalized?: boolean