Class MargaritaForm<FIELD>

Type Parameters

FIELD extends MFF<any> = MFF

Hierarchy (View Summary)

MargaritaFormControl<FIELD>
- MargaritaForm

Index

Constructors

Methods

_getCustomContext _getStateFactories _startAfterInitializeLoop _startOnInitializeLoop _startPrepareLoop generateContext initialize setError addContextValue addExtension addManager addStates addValidator extend extendContext removeContextValue removeExtension removeManager setGlobalConfig

Constructors

constructor

new MargaritaForm<FIELD extends MFF<any> = MFF>(
_field: FIELD,
): MargaritaForm<FIELD>
Type Parameters
- FIELD extends MFF<any> = MFF
Parameters
- _field: FIELD
Returns MargaritaForm<FIELD>
Overrides MargaritaFormControl.constructor
- Defined in margarita-form.ts:5

Properties

_buildParams

_buildParams: ControlBuildParams = ...

_field

_field: FIELD

activate

activate: () => void = ...

addControl

addControl: <CHILD_FIELD extends any>(
field: CHILD_FIELD,
replaceExisting?: boolean,
) => MFC<CHILD_FIELD> = ...

Add new control to the form group.

Type declaration

- <CHILD_FIELD extends any>(
  field: CHILD_FIELD,
  replaceExisting?: boolean,
  ): MFC<CHILD_FIELD>
- Type Parameters
  - CHILD_FIELD extends any
  Parameters
  - field: CHILD_FIELD
    The field to use as a template for the new control
  - OptionalreplaceExisting: boolean
    Replace existing control with the same name when parent is not an array type
  Returns MFC<CHILD_FIELD>
  Control that was added

addValue

addValue: (
    value: ControlValueItem<FIELD>,
    mustBeUnique?: boolean,
    setAsDirty?: boolean,
    emitEvent?: boolean,
) => void = ...

Add a new value to array

Type declaration

- (
      value: ControlValueItem<FIELD>,
      mustBeUnique?: boolean,
      setAsDirty?: boolean,
      emitEvent?: boolean,
  ): void
- Parameters
  - value: ControlValueItem<FIELD>
    Value to add to the array
  - OptionalmustBeUnique: boolean
    Should the value be unique (default = false)
  - OptionalsetAsDirty: boolean
    Should the dirty state be set to true
  - OptionalemitEvent: boolean
  Returns void

appendControl

appendControl: <CHILD_FIELD extends MFF<FieldParams> = FIELD>(
fieldTemplate?: string | CHILD_FIELD,
overrides?: Partial<CHILD_FIELD>,
) => null | MFC<CHILD_FIELD> = ...

Add new control to the form array.

appendControls

appendControls: <CHILD_FIELD extends MFF<FieldParams> = FIELD>(
fieldTemplates: string[] | CHILD_FIELD[],
) => MFC<CHILD_FIELD>[] = ...

Add new controls to the form array.

changes

changes: BehaviorSubject<ControlChange>

cleanup

cleanup: () => void = ...

Unsubscribe from all subscriptions for current control

clear

clear: (resetChildren?: boolean) => void = ...

clearValue

clearValue: (
    setDirtyAs?: boolean,
    resetChildren?: boolean,
    origin?: boolean,
) => void = ...

deactivate

deactivate: () => void = ...

disable

disable: () => void = ...

dispatch

dispatch: (
    action: any,
    setAsDirty?: boolean,
    emitEvent?: boolean,
) => Promise<void> = ...

Run value through field's dispatcher and set the result as the new value

emitChange

emitChange: (
    name: ControlChangeName,
    change: unknown,
    origin?: MFC<any>,
) => void = ...

enable

enable: () => void = ...

error

error: undefined | Error

field

field: FIELD

findControl

findControl: <
    FIELD_TYPE,
    IDENTIFIER extends any = DeepControlIdentifier<FIELD>,
    _T = ChildControl<FIELD_TYPE, IDENTIFIER, FIELD, ChildField<FIELD>>,
>(
    identifier: IDENTIFIER,
) => undefined | _T = ...

Find control with identifier. Searches all child controls recursively and returns the first match.

Type declaration

- <
      FIELD_TYPE,
      IDENTIFIER extends any = DeepControlIdentifier<FIELD>,
      _T = ChildControl<FIELD_TYPE, IDENTIFIER, FIELD, ChildField<FIELD>>,
  >(
      identifier: IDENTIFIER,
  ): undefined | _T
- Type Parameters
  - FIELD_TYPE
  - IDENTIFIER extends any = DeepControlIdentifier<FIELD>
  - _T = ChildControl<FIELD_TYPE, IDENTIFIER, FIELD, ChildField<FIELD>>
  Parameters
  - identifier: IDENTIFIER
    name, index or key of the control. Provide an array of identifiers to get nested control.
  Returns undefined | _T
  The control that was found or added or null if control doesn't exist.

get

get: <VALUE>(key: OrString | (keyof MFC<MFGF<FieldParams>>)) => VALUE = ...

In some cases type of an attribute is not known by the compiler. Use this method to get the attribute with correct type.

Type declaration

- <VALUE>(key: OrString | (keyof MFC<MFGF<FieldParams>>)): VALUE
- Type Parameters
  - VALUE
  Parameters
  - key: OrString | (keyof MFC<MFGF<FieldParams>>)
    The key of the attribute
  Returns VALUE
  The attribute value with custom type

getActiveSiblings

getActiveSiblings: <SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>() => MFC<
SIBLING_FIELD,
>[] = ...

Get all active sibling controls as an array

Type declaration

- <SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>(): MFC<
  SIBLING_FIELD,
  >[]
- Type Parameters
  - SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>
  Returns MFC<SIBLING_FIELD>[]
  Array of active sibling controls

Throws

Error if control is root

getControl

getControl: <
    FIELD_TYPE,
    IDENTIFIER extends any = DeepControlIdentifier<FIELD>,
    _T = ChildControl<FIELD_TYPE, IDENTIFIER, FIELD, ChildField<FIELD>>,
>(
    identifier: IDENTIFIER,
) => ControlValue<FIELD> extends any[] ? undefined | _T : _T = ...

Get control with identifier

Type declaration

- <
      FIELD_TYPE,
      IDENTIFIER extends any = DeepControlIdentifier<FIELD>,
      _T = ChildControl<FIELD_TYPE, IDENTIFIER, FIELD, ChildField<FIELD>>,
  >(
      identifier: IDENTIFIER,
  ): ControlValue<FIELD> extends any[] ? undefined | _T : _T
- Type Parameters
  - FIELD_TYPE
  - IDENTIFIER extends any = DeepControlIdentifier<FIELD>
  - _T = ChildControl<FIELD_TYPE, IDENTIFIER, FIELD, ChildField<FIELD>>
  Parameters
  - identifier: IDENTIFIER
    name, index or key of the control. Provide an array of identifiers to get nested control.
  Returns ControlValue<FIELD> extends any[] ? undefined | _T : _T
  The control that was found or added or null if control doesn't exist.

getControls

getControls: <FIELD extends MFF<FieldParams> = ChildField<FIELD>>(
states?: string | string[],
) => MFC<FIELD>[] = ...

Get all controls that match required states

getFieldValue

getFieldValue: <OUTPUT = unknown>(
key: keyof FIELD,
defaultValue?: OUTPUT,
) => OUTPUT = ...

Get the control's field's value

Type declaration

- <OUTPUT = unknown>(key: keyof FIELD, defaultValue?: OUTPUT): OUTPUT
- Type Parameters
  - OUTPUT = unknown
  Parameters
  - key: keyof FIELD
    The field to get
  - OptionaldefaultValue: OUTPUT
  Returns OUTPUT
  Field's value or fallback

getManager

getManager: <MANAGER>(key: string) => MANAGER = ...

getOrAddControl

getOrAddControl: <CHILD_FIELD extends any>(
field: CHILD_FIELD,
) => MFC<CHILD_FIELD> = ...

Get control or add it if it doesn't exist. NOTE: If grouping is array this method might not work as expected as arrays allow multiple controls with the same name!

Type declaration

- <CHILD_FIELD extends any>(field: CHILD_FIELD): MFC<CHILD_FIELD>
- Type Parameters
  - CHILD_FIELD extends any
  Parameters
  - field: CHILD_FIELD
    The field to use as a template for the new control
  Returns MFC<CHILD_FIELD>
  The control that was found or added

getPath

getPath: (outcome?: "controls" | "keys" | "default" | "uids") => ControlPath = ...

getSibling

getSibling: <SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>(
identifier: ControlIdentifier,
) => MFC<SIBLING_FIELD> = ...

Get sibling control with identifier

Type declaration

- <SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>(
  identifier: ControlIdentifier,
  ): MFC<SIBLING_FIELD>
- Type Parameters
  - SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>
  Parameters
  - identifier: ControlIdentifier
    name, index or key of the control
  Returns MFC<SIBLING_FIELD>
  The control that was found or added or null if control doesn't exist.

Throws

Error if control is root

getSiblings

getSiblings: <SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>() => MFC<
SIBLING_FIELD,
>[] = ...

Get all sibling controls as an array

Type declaration

- <SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>(): MFC<
  SIBLING_FIELD,
  >[]
- Type Parameters
  - SIBLING_FIELD extends MFF<FieldParams> = MFGF<FieldParams>
  Returns MFC<SIBLING_FIELD>[]
  Array of sibling controls

Throws

Error if control is root

getState

getState: <T extends keyof MargaritaFormState>(key: T) => MargaritaFormState[T] = ...

getStateChanges

getStateChanges: <T extends keyof MargaritaFormState>(
key: T,
) => Observable<MargaritaFormState[T]> = ...

hasControl

hasControl: (identifier: ControlIdentifier) => boolean = ...

Check if control exists

Type declaration

- (identifier: ControlIdentifier): boolean
- Parameters
  - identifier: ControlIdentifier
    name, index or key of the control
  Returns boolean
  boolean

initialized

initialized: boolean = false

key

key: string

managers

managers: Managers = ...

moveControl

moveControl: <IDENTIFIER extends any = DeepControlIdentifier<FIELD>>(
identifier: IDENTIFIER,
index: number,
) => void = ...

Moves a child control to a new index in the array.

Type declaration

- <IDENTIFIER extends any = DeepControlIdentifier<FIELD>>(
  identifier: IDENTIFIER,
  index: number,
  ): void
- Type Parameters
  - IDENTIFIER extends any = DeepControlIdentifier<FIELD>
  Parameters
  - identifier: IDENTIFIER
    name, index or key of the control to move
  - index: number
  Returns void

moveToIndex

moveToIndex: (index: number) => void = ...

Move control to another index

patchValue

patchValue: (
    value: undefined | null | Partial<ControlValue<FIELD>>,
    setAsDirty?: boolean,
    emitEvent?: boolean,
) => void = ...

Set value of the control group by updating it's childrens values. Unlike setValue, this method will not delete children values if they are not present in the new value.

Type declaration

- (
      value: undefined | null | Partial<ControlValue<FIELD>>,
      setAsDirty?: boolean,
      emitEvent?: boolean,
  ): void
- Parameters
  - value: undefined | null | Partial<ControlValue<FIELD>>
  - OptionalsetAsDirty: boolean
    update dirty state to true
  - OptionalemitEvent: boolean
  Returns void

prepared

prepared: boolean = false

queryControls

queryControls: <RESULT_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>(
query: (control: MFC<MFGF<FieldParams>>) => boolean,
recursive?: boolean,
) => MFC<RESULT_FIELD>[] = ...

Find control where query function returns true. Can search all child controls recursively to get all matches in the tree.

Type declaration

- <RESULT_FIELD extends MFF<FieldParams> = MFGF<FieldParams>>(
  query: (control: MFC<MFGF<FieldParams>>) => boolean,
  recursive?: boolean,
  ): MFC<RESULT_FIELD>[]
- Type Parameters
  - RESULT_FIELD extends MFF<FieldParams> = MFGF<FieldParams>
  Parameters
  - query: (control: MFC<MFGF<FieldParams>>) => boolean
    Query function that returns true if control matches
  - Optionalrecursive: boolean
    Should the query be run recursively
  Returns MFC<RESULT_FIELD>[]
  The control that was found or undefined if control doesn't exist.

ready

ready: boolean = false

redo

redo: () => void

registerResolver

registerResolver: (key: string, resolver: MargaritaFormResolver) => void = ...

Type declaration

- (key: string, resolver: MargaritaFormResolver): void
- Parameters
  - key: string
  - resolver: MargaritaFormResolver
    MargaritaFormResolver
  Returns void

registerValidator

registerValidator: (key: string, validator: MargaritaFormValidator) => void = ...

reInitialize

reInitialize: () => void = ...

Resubscribe to all subscriptions for current control

remove

remove: () => void = ...

Remove the control from the parent

removeControl

removeControl: <IDENTIFIER extends any = DeepControlIdentifier<FIELD>>(
identifier: IDENTIFIER,
) => void = ...

Removes a child control from the form group.

Type declaration

- <IDENTIFIER extends any = DeepControlIdentifier<FIELD>>(
  identifier: IDENTIFIER,
  ): void
- Type Parameters
  - IDENTIFIER extends any = DeepControlIdentifier<FIELD>
  Parameters
  - identifier: IDENTIFIER
    name, index or key of the control to remove
  Returns void

removeValue

removeValue: (
    value: ControlValueItem<FIELD>,
    setAsDirty?: boolean,
    emitEvent?: boolean,
) => void = ...

Remove a value from array

Type declaration

- (
      value: ControlValueItem<FIELD>,
      setAsDirty?: boolean,
      emitEvent?: boolean,
  ): void
- Parameters
  - value: ControlValueItem<FIELD>
    Value to remove from the array
  - OptionalsetAsDirty: boolean
    Should the dirty state be set to true
  - OptionalemitEvent: boolean
  Returns void

reset

reset: (resetChildren?: boolean, origin?: boolean) => void = ...

resetState

resetState: (respectField?: boolean, resetChildren?: boolean) => void = ...

resetValue

resetValue: (
    setDirtyAs?: boolean,
    resetChildren?: boolean,
    origin?: boolean,
) => void = ...

setField

setField: (field: FIELD, resetControl?: boolean) => Promise<void> = ...

setRef

setRef: (ref: any) => void = ...

Connect control to a HTML element.

Example: React

Example: Vanilla JS

const el = document.querySelector('#myInput');
control.setRef(el);

setValue

setValue: (
    value: undefined | null | ControlValue<FIELD>,
    setAsDirty?: boolean,
    emitEvent?: boolean,
) => void = ...

Set value of the control

Type declaration

- (
      value: undefined | null | ControlValue<FIELD>,
      setAsDirty?: boolean,
      emitEvent?: boolean,
  ): void
- Parameters
  - value: undefined | null | ControlValue<FIELD>
    value to set
  - OptionalsetAsDirty: boolean
    update dirty state to true
  - OptionalemitEvent: boolean
  Returns void

submit

submit: <OUTPUT, PARAMS = object>(params?: PARAMS) => Promise<OUTPUT> = ...

Submit the form. If the form is invalid, the invalid submit handler will be called. Define submit handlers in the field's handleSubmit property. You can define a different handler for valid and invalid submits but only valid submit handler is required. If handleSubmit is a function it will be used as the valid handler. If handleSubmit or handleSubmit.valid is a string, it will be used as a url for a POST request.

Type declaration

- <OUTPUT, PARAMS = object>(params?: PARAMS): Promise<OUTPUT>
- Type Parameters
  - OUTPUT
  - PARAMS = object
  Parameters
  - Optionalparams: PARAMS
    Params that get passed as the second argument to the submit handler
  Returns Promise<OUTPUT>
  Promise with the submit handler's response

subscriptions

subscriptions: Subscription[] = []

syncId

syncId: string = ...

toggleActive

toggleActive: () => void = ...

toggleEnabled

toggleEnabled: () => void = ...

toggleValue

toggleValue: (
    value: ControlValueItem<FIELD>,
    mustBeUnique?: boolean,
    setAsDirty?: boolean,
    emitEvent?: boolean,
) => void = ...

Toggle a value in array

Type declaration

- (
      value: ControlValueItem<FIELD>,
      mustBeUnique?: boolean,
      setAsDirty?: boolean,
      emitEvent?: boolean,
  ): void
- Parameters
  - value: ControlValueItem<FIELD>
    Value to add or remove from the array
  - OptionalmustBeUnique: boolean
    Should the value be unique when adding (default = true)
  - OptionalsetAsDirty: boolean
    Should the dirty state be set to true
  - OptionalemitEvent: boolean
  Returns void

uid

uid: string

undo

undo: () => void

updateField

updateField: (field: Partial<FIELD>, resetControl?: boolean) => Promise<void> = ...

updateKey

updateKey: () => void = ...

updateState

updateState: <T extends Partial<MargaritaFormState>>(
changes: T,
) => Promise<boolean> = ...

updateStateValue

updateStateValue: <T extends keyof MargaritaFormState>(
key: T,
value: MargaritaFormState[T],
) => Promise<boolean> = ...

updateSyncId

updateSyncId: () => void = ...

updateUid

updateUid: () => void = ...

validate

validate: (setAsTouched?: boolean) => Promise<boolean> = ...

Validate the control and update state. Mark the control as touched to show errors.

Type declaration

- (setAsTouched?: boolean): Promise<boolean>
- Parameters
  - OptionalsetAsTouched: boolean
    Set the touched state to true
  Returns Promise<boolean>

`Static`config

config: Partial<MargaritaFormConfig> = {}

`Static`context

context: Partial<ControlContext<any, any>> = {}

`Static`extensions

extensions: Set<typeof ExtensionBase> = ...

`Static`managers

managers: Record<string, typeof _ManagerLike> = ...

`Static`states

states: Set<
    (
        state: StateManager<MFC>,
    ) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>,
> = ...

`Static`validators

validators: Record<string, MargaritaFormValidator> = ...

Accessors

activeControls

get activeControls(): MFC<ChildField<FIELD>>[]
Get all active controls as an array

Returns MFC<ChildField<FIELD>>[]
Inherited from MargaritaFormControl.activeControls
- Defined in margarita-form-control.ts:560

activeExtensions

get activeExtensions(): ExtensionBase[]
Returns ExtensionBase[]
Inherited from MargaritaFormControl.activeExtensions
- Defined in margarita-form-control.ts:206

afterChanges

get afterChanges(): Observable<ControlChange>
Returns Observable<ControlChange>
Inherited from MargaritaFormControl.afterChanges
- Defined in margarita-form-control.ts:324

allErrors

get allErrors(): { control: MFC; error: Error }[]
Returns { control: MFC; error: Error }[]
Inherited from MargaritaFormControl.allErrors
- Defined in margarita-form-control.ts:805

childChanges

get childChanges(): Observable<ControlChange>
Returns Observable<ControlChange>
Inherited from MargaritaFormControl.childChanges
- Defined in margarita-form-control.ts:320

config

get config(): MargaritaFormConfig
Returns MargaritaFormConfig
Inherited from MargaritaFormControl.config
- Defined in margarita-form-control.ts:172

context

get context(): ControlContext<MFC<FIELD>, never>
Returns ControlContext<MFC<FIELD>, never>
Inherited from MargaritaFormControl.context
- Defined in margarita-form-control.ts:891

controls

get controls(): MFC<ChildField<FIELD>>[]
Get all controls as an array

Returns MFC<ChildField<FIELD>>[]
Inherited from MargaritaFormControl.controls
- Defined in margarita-form-control.ts:553

currentLocale

get currentLocale(): string | number
Returns string | number
Inherited from MargaritaFormControl.currentLocale
- Defined in extensions/i18n/i18n-types.ts:73

currentRef

get currentRef(): | null
| MargaritaFormBaseElement<MFC<MFGF<FieldParams>>, HTMLElement>
Get the control's reference to a HTML element

Returns null | MargaritaFormBaseElement<MFC<MFGF<FieldParams>>, HTMLElement>
Inherited from MargaritaFormControl.currentRef
- Defined in margarita-form-control.ts:766

errorMessage

get errorMessage(): undefined | string
Returns undefined | string
Inherited from MargaritaFormControl.errorMessage
- Defined in margarita-form-control.ts:793

expectArray

get expectArray(): boolean
Check if control's output should be an array

Returns boolean
Inherited from MargaritaFormControl.expectArray
- Defined in margarita-form-control.ts:255

expectChildControls

get expectChildControls(): boolean
Check if control's output should be an group / object

Returns boolean
Inherited from MargaritaFormControl.expectChildControls
- Defined in margarita-form-control.ts:276

expectFlat

get expectFlat(): boolean
Check if control's output should be merged to parent

Returns boolean
Inherited from MargaritaFormControl.expectFlat
- Defined in margarita-form-control.ts:262

expectGroup

get expectGroup(): boolean
Check if control's output should be an group / object

Returns boolean
Inherited from MargaritaFormControl.expectGroup
- Defined in margarita-form-control.ts:269

extensions

get extensions(): Extensions
Returns Extensions
Inherited from MargaritaFormControl.extensions
- Defined in margarita-form-control.ts:70

fieldChanges

get fieldChanges(): Observable<FIELD>
Returns Observable<FIELD>
Inherited from MargaritaFormControl.fieldChanges
- Defined in margarita-form-control.ts:294

fields

get fields(): ChildField<FIELD>[]
Returns ChildField<FIELD>[]
Inherited from MargaritaFormControl.fields
- Defined in margarita-form-control.ts:282

grouping

get grouping(): MargaritaFormGroupings
Get the way how the child controls should be grouped

Returns MargaritaFormGroupings
Inherited from MargaritaFormControl.grouping
- Defined in margarita-form-control.ts:248

hasActiveControls

get hasActiveControls(): boolean
Check if control has any active child controls

Returns boolean
Inherited from MargaritaFormControl.hasActiveControls
- Defined in margarita-form-control.ts:546

hasControls

get hasControls(): boolean
Check if control has any child controls

Returns boolean
Inherited from MargaritaFormControl.hasControls
- Defined in margarita-form-control.ts:539

history

get history(): HistoryEntry[]
Returns HistoryEntry[]
Inherited from MargaritaFormControl.history
- Defined in extensions/history/history-extension-types.ts:11

i18n

get i18n(): FIELD["__i18n"]
Returns FIELD["__i18n"]
Inherited from MargaritaFormControl.i18n
- Defined in extensions/i18n/i18n-types.ts:71

index

get index(): number
Returns number
Inherited from MargaritaFormControl.index
- Defined in margarita-form-control.ts:222

isDefaultValue

get isDefaultValue(): boolean
Check if the control's value is the same as the default value

Returns boolean
Inherited from MargaritaFormControl.isDefaultValue
- Defined in margarita-form-control.ts:345

isInitialValue

get isInitialValue(): boolean
Check if the control's value is the same as the initial value. Warning: this works properly only in the root level. Use defaultValue and isDefaultValue to add checks for child controls

Returns boolean
Inherited from MargaritaFormControl.isInitialValue
- Defined in margarita-form-control.ts:339

isRoot

get isRoot(): boolean
Returns boolean
Inherited from MargaritaFormControl.isRoot
- Defined in margarita-form-control.ts:161

locales

get locales(): Locales
Returns Locales
Inherited from MargaritaFormControl.locales
- Defined in extensions/i18n/i18n-types.ts:72

name

get name(): FIELD["name"] extends string ? any[any] : string
Returns FIELD["name"] extends string ? any[any] : string
Inherited from MargaritaFormControl.name
- Defined in margarita-form-control.ts:218

onSubmit

get onSubmit(): Observable<MFC<FIELD>>
Returns Observable<MFC<FIELD>>
Inherited from MargaritaFormControl.onSubmit
- Defined in margarita-form-control.ts:772

ownChanges

get ownChanges(): Observable<ControlChange>
Returns Observable<ControlChange>
Inherited from MargaritaFormControl.ownChanges
- Defined in margarita-form-control.ts:316

params

get params(): Params
Returns Params
Inherited from MargaritaFormControl.params
- Defined in managers/params-manager.ts:31

paramsChanges

get paramsChanges(): Observable<Params>
Returns Observable<Params>
Inherited from MargaritaFormControl.paramsChanges
- Defined in managers/params-manager.ts:32

parent

get parent(): MFC<MFGF<FieldParams>>
Returns MFC<MFGF<FieldParams>>
Inherited from MargaritaFormControl.parent
- Defined in margarita-form-control.ts:165

resolvers

get resolvers(): MargaritaFormResolvers
Get resolvers for the control

Returns MargaritaFormResolvers
Inherited from MargaritaFormControl.resolvers
- Defined in margarita-form-control.ts:511

root

get root(): MFC<MFGF<FieldParams>>
Returns MFC<MFGF<FieldParams>>
Inherited from MargaritaFormControl.root
- Defined in margarita-form-control.ts:157

state

get state(): MargaritaFormState
Returns MargaritaFormState
Inherited from MargaritaFormControl.state
- Defined in margarita-form-control.ts:428

stateChanges

get stateChanges(): Observable<MargaritaFormState>
Returns Observable<MargaritaFormState>
Inherited from MargaritaFormControl.stateChanges
- Defined in margarita-form-control.ts:432

storage

get storage(): StorageExtensionBase
Returns StorageExtensionBase
Inherited from MargaritaFormControl.storage
- Defined in extensions/storage/storage-extension-types.ts:15

syncronization

get syncronization(): undefined | typeof SyncronizationExtensionBase
Returns undefined | typeof SyncronizationExtensionBase
Inherited from MargaritaFormControl.syncronization
- Defined in extensions/syncronization/syncronization-extension-types.ts:18

validators

get validators(): MargaritaFormValidators
Returns MargaritaFormValidators
Inherited from MargaritaFormControl.validators
- Defined in margarita-form-control.ts:447

value

get value(): ControlValue<FIELD>
Returns ControlValue<FIELD>
Inherited from MargaritaFormControl.value
- Defined in margarita-form-control.ts:330
set value(value: ControlValue<FIELD>): void
Parameters
- value: ControlValue<FIELD>
Returns void
Inherited from MargaritaFormControl.value
- Defined in margarita-form-control.ts:334

valueChanges

get valueChanges(): Observable<ControlValue<FIELD>>
Listen to value changes of the control

Returns Observable<ControlValue<FIELD>>
Inherited from MargaritaFormControl.valueChanges
- Defined in margarita-form-control.ts:353

valueHash

get valueHash(): string
Returns string
Inherited from MargaritaFormControl.valueHash
- Defined in margarita-form-control.ts:232

visibleControls

get visibleControls(): MFC<ChildField<FIELD>>[]
Get all visible controls as an array

Returns MFC<ChildField<FIELD>>[]
Inherited from MargaritaFormControl.visibleControls
- Defined in margarita-form-control.ts:567

Methods

_getCustomContext

_getCustomContext(): Context
Internal
Returns Context
Inherited from MargaritaFormControl._getCustomContext
- Defined in margarita-form-control.ts:860

_getStateFactories

_getStateFactories(
    global?: boolean,
): (
    (
        state: StateManager<MFC>,
    ) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>
)[]
Parameters
- Optionalglobal: boolean
Returns (
    (
        state: StateManager<MFC>,
    ) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>
)[]
Inherited from MargaritaFormControl._getStateFactories
- Defined in managers/state-manager.ts:35

_startAfterInitializeLoop

_startAfterInitializeLoop(): void
Returns void
Inherited from MargaritaFormControl._startAfterInitializeLoop
- Defined in margarita-form-control.ts:928

_startOnInitializeLoop

_startOnInitializeLoop(): void
Returns void
Inherited from MargaritaFormControl._startOnInitializeLoop
- Defined in margarita-form-control.ts:922

_startPrepareLoop

_startPrepareLoop(): void
Returns void
Inherited from MargaritaFormControl._startPrepareLoop
- Defined in margarita-form-control.ts:916

generateContext

generateContext<PARAMS>(
params?: PARAMS,
overrides?: CommonRecord,
): ControlContext<MargaritaForm<FIELD>, PARAMS>
Internal
Type Parameters
- PARAMS
Parameters
- Optionalparams: PARAMS
- overrides: CommonRecord = {}
Returns ControlContext<MargaritaForm<FIELD>, PARAMS>
Inherited from MargaritaFormControl.generateContext
- Defined in margarita-form-control.ts:879

initialize

initialize(): void
Returns void
Inherited from MargaritaFormControl.initialize
- Defined in margarita-form-control.ts:108

setError

setError(error: undefined | string | Error): void
Parameters
- error: undefined | string | Error
Returns void
Inherited from MargaritaFormControl.setError
- Defined in margarita-form-control.ts:797

`Static`addContextValue

addContextValue<T extends keyof ControlContext<MFC<MFGF>, any>>(
key: T,
value: ControlContext<MFC<MFGF>, any>[T],
): void
Type Parameters
- T extends keyof ControlContext<MFC<MFGF>, any>
Parameters
- key: T
- value: ControlContext<MFC<MFGF>, any>[T]
Returns void
Inherited from MargaritaFormControl.addContextValue
- Defined in margarita-form-control.ts:990

`Static`addExtension

addExtension<T extends typeof ExtensionBase>(extension: T): void
Type Parameters
- T extends typeof ExtensionBase
Parameters
- extension: T
Returns void
Inherited from MargaritaFormControl.addExtension
- Defined in margarita-form-control.ts:976

`Static`addManager

addManager<T extends typeof _ManagerLike>(manager: T): void
Type Parameters
- T extends typeof _ManagerLike
Parameters
- manager: T
Returns void
Inherited from MargaritaFormControl.addManager
- Defined in margarita-form-control.ts:966

`Static`addStates

addStates(
    ...states: (
        (
            state: StateManager<MFC>,
        ) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>
    )[],
): void
Parameters
- ...states: (
      (
          state: StateManager<MFC>,
      ) => BooleanPairState | GeneralState<unknown> | DerivedState<unknown>
  )[]
Returns void
Inherited from MargaritaFormControl.addStates
- Defined in margarita-form-control.ts:1002

`Static`addValidator

addValidator(key: string, validator: MargaritaFormValidator): void
Parameters
- key: string
- validator: MargaritaFormValidator
Returns void
Inherited from MargaritaFormControl.addValidator
- Defined in margarita-form-control.ts:986

`Static`extend

extend(
    source: Partial<MargaritaFormControl<any>> & ThisType<
        MargaritaFormControl<any>,
    >,
): void
Parameters
- source: Partial<MargaritaFormControl<any>> & ThisType<MargaritaFormControl<any>>
Returns void
Inherited from MargaritaFormControl.extend
- Defined in margarita-form-control.ts:946

`Static`extendContext

extendContext(context: Partial<ControlContext<MFC<MFGF>, any>>): void
Parameters
- context: Partial<ControlContext<MFC<MFGF>, any>>
Returns void
Inherited from MargaritaFormControl.extendContext
- Defined in margarita-form-control.ts:998

`Static`removeContextValue

removeContextValue<T extends keyof ControlContext<MFC<MFGF>, any>>(key: T): void
Type Parameters
- T extends keyof ControlContext<MFC<MFGF>, any>
Parameters
- key: T
Returns void
Inherited from MargaritaFormControl.removeContextValue
- Defined in margarita-form-control.ts:994

`Static`removeExtension

removeExtension<T extends typeof ExtensionBase>(extension: T): void
Type Parameters
- T extends typeof ExtensionBase
Parameters
- extension: T
Returns void
Inherited from MargaritaFormControl.removeExtension
- Defined in margarita-form-control.ts:982

`Static`removeManager

removeManager(key: string): void
Parameters
- key: string
Returns void
Inherited from MargaritaFormControl.removeManager
- Defined in margarita-form-control.ts:972

`Static`setGlobalConfig

setGlobalConfig(config: Partial<MargaritaFormConfig>): void
Parameters
- config: Partial<MargaritaFormConfig>
Returns void
Inherited from MargaritaFormControl.setGlobalConfig
- Defined in margarita-form-control.ts:962

Class MargaritaForm<FIELD>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MargaritaForm<FIELD>

Properties

_buildParams

_field

activate

addControl

Type declaration

Type Parameters

Parameters

Returns MFC<CHILD_FIELD>

addValue

Type declaration

Parameters

Returns void

appendControl

appendControls

changes

cleanup

clear

clearValue

deactivate

disable

dispatch

emitChange

enable

error

field

findControl

Type declaration

Type Parameters

Parameters

Returns undefined | _T

get

Type declaration

Type Parameters

Parameters

Returns VALUE

getActiveSiblings

Type declaration

Type Parameters

Returns MFC<SIBLING_FIELD>[]

Throws

getControl

Type declaration

Type Parameters

Parameters

Returns ControlValue<FIELD> extends any[] ? undefined | _T : _T

getControls

getFieldValue

Type declaration

Type Parameters

Parameters

Returns OUTPUT

getManager

getOrAddControl

Type declaration

Type Parameters

Parameters

Returns MFC<CHILD_FIELD>

getPath

getSibling

Type declaration

Type Parameters

Parameters

Returns MFC<SIBLING_FIELD>

Throws

getSiblings

Type declaration