Interface MargaritaFormField<FP>

interface MargaritaFormField<FP> {
    __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 full)

Properties

__fields? __i18n? __params? __value? active? afterSubmit? attributes? beforeSubmit? config? context? currentLocale? customStates? defaultValue? disabled? dispatcher? editable? enabled? extensions? fieldModifiers? fields? grouping? handleLocalize? handleSubmit? hidden? htmlTemplate? i18n? inactive? initialValue? isLocaleField? locales? localize? managers? name onChanges? onChildControlChanges? onCreate? onRemove? onStateChanges? onValueChanges? params? readOnly? resolvers? startWith? storage? transformer? validation? validators? valueResolver? visible? wasLocalized?

Properties

Optional__fields

__fields?: FP["fields"] extends object
    ? any[any][]
    : MFGF<FieldParams>[]

Optional__i18n

__i18n?: FP["i18n"]

Optional__params

__params?: FP

Optional__value

__value?: FP["value"]

Optionalactive

active?: UserDefinedStateResolver<MargaritaFormFieldState>

OptionalafterSubmit

afterSubmit?: MargaritaFormResolver

Optionalattributes

attributes?: MargaritaFormFieldAttributes

OptionalbeforeSubmit

beforeSubmit?: MargaritaFormResolver

Optionalconfig

config?: MargaritaFormConfig

Optionalcontext

context?: Context

OptionalcurrentLocale

currentLocale?: string | number

OptionalcustomStates

customStates?: ((state: StateManager<MFC>) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>)[]

OptionaldefaultValue

defaultValue?: FieldValue<ReplaceAny<FP["value"], unknown>>

Optionaldisabled

disabled?: UserDefinedStateResolver<MargaritaFormFieldState>

Optionaldispatcher

dispatcher?: MargaritaFormResolver<FP["value"]> | NotFunction

Optionaleditable

editable?: UserDefinedStateResolver<MargaritaFormFieldState>

Optionalenabled

enabled?: UserDefinedStateResolver<MargaritaFormFieldState>

Optionalextensions

extensions?: ExtensionsArray

OptionalfieldModifiers

fieldModifiers?: FieldModifiers

Optionalfields

fields?: FP["fields"] extends object
    ? FieldChild<any[any]>[]
    : FP["fields"] extends never
        ? never
        : MFGF<FieldParams>[]

Optionalgrouping

grouping?: CoreGetter<MargaritaFormGroupings>

OptionalhandleLocalize

handleLocalize?: MargaritaFormHandleLocalize<MFGF>

OptionalhandleSubmit

handleSubmit?: string | MargaritaFormSubmitHandler<MFGF<{
    value: FP["value"];
}>> | MargaritaFormSubmitHandlers<MFGF<{
    value: FP["value"];
}>>

Optionalhidden

hidden?: UserDefinedStateResolver<MargaritaFormFieldState>

OptionalhtmlTemplate

htmlTemplate?: string

Optionali18n

i18n?: I18NField<FP["i18n"]>

Optionalinactive

inactive?: UserDefinedStateResolver<MargaritaFormFieldState>

OptionalinitialValue

initialValue?: FieldValue<ReplaceAny<FP["value"], unknown>>

OptionalisLocaleField

isLocaleField?: boolean

Optionallocales

locales?: Locales

Optionallocalize

localize?: boolean

Optionalmanagers

managers?: Partial<Managers>

name

name: FP["name"] extends FieldName
    ? any[any]
    : FieldName

OptionalonChanges

onChanges?: MargaritaFormResolver

OptionalonChildControlChanges

onChildControlChanges?: MargaritaFormResolver

OptionalonCreate

onCreate?: MargaritaFormResolver

OptionalonRemove

onRemove?: MargaritaFormResolver

OptionalonStateChanges

onStateChanges?: MargaritaFormResolver

OptionalonValueChanges

onValueChanges?: MargaritaFormResolver

Optionalparams

params?: MargaritaFormFieldParams

OptionalreadOnly

readOnly?: UserDefinedStateResolver<MargaritaFormFieldState>

Optionalresolvers

resolvers?: MargaritaFormResolvers

OptionalstartWith

startWith?: CoreGetter<StartWith>

Optionalstorage

storage?: boolean

Optionaltransformer

transformer?: MargaritaFormResolver<FP["value"]>

Optionalvalidation

validation?: MargaritaFormFieldValidation<FP["value"]>

Optionalvalidators

validators?: MargaritaFormValidators

OptionalvalueResolver

valueResolver?: MargaritaFormResolver<FP["value"]> | NotFunction

Optionalvisible

visible?: UserDefinedStateResolver<MargaritaFormFieldState>

OptionalwasLocalized

wasLocalized?: boolean

Settings

Member Visibility

On This Page

Properties