Skip to main content
Version: Next

Decorators

Model decorators​

ngx-form-object exposes three model decorators: Attribute(), BelongsTo(), and HasMany(). These decorators are used for specifying what kind of form controls should be created for different model properties.

@Attribute()​

ExtendedFormControls will be created for model properties decorated with the Attribute(options: PropertyOptions) decorator. See PropertyOptions for more information about the decorator options

@BelongsTo(options: PropertyOptions)​

ExtendedFormControls will be created for model properties decorated with the BelongsTo(options: PropertyOptions) decorator. See PropertyOptions for more information about the decorator options

@HasMany(options: PropertyOptions)​

Empty ExtendedFormArray will be created for model properties decorated with the HasMany(options: PropertyOptions) decorator. See PropertyOptions for more information about the decorator options

PropertyOptions​

Each of the decorators accepts a PropertyOptions optional argument.

A custom isChanged(initialValue: any, currentValue: any): boolean function can be defined in the options argument. If defined, this function overrides the default isChanged behavior for that attribute.

You can override default control types in FormObject.

Method decorators​

@BuildControl(propertyName: string)​

Requires relationship propertyName as an argument which must be equal to the property name defined in the model. Can be used for creating custom relationship forms. Find out more.

@BuildRelationshipFormObject(propertyName: string)​

Requires relationship propertyName as an argument which must be equal to the property name defined in the model. Can be used for creating complex relationship structures. Find out more.