Interface IFieldConfigurationObject

Added in 6.18.0

You can specify your own class that will be applied to the formly-field directive (or ng-form of a fieldGroup).

This is a great way to add custom behavior to a specific field. It is injectable with the $scope of the field, and anything else you have in your injector.

This is reserved for the developer. You have our guarantee to be able to use this and not worry about future versions of formly overriding your usage and preventing you from upgrading :-)

Use defaultValue to initialize it the model. If this is provided and the value of the model at compile-time is undefined, then the value of the model will be assigned to defaultValue.

An object where the key is a property to be set on the main field config and the value is an expression used to assign that property. The value is a formly expressions. The returned value is wrapped in $q.when so you can return a promise from your function :-)

This is the NgModelController for the field. It provides you with awesome stuff like $errors :-)

Uses ng-if. Whether to hide the field. Defaults to false. If you wish this to be conditional, use hideExpression. See below.

This is similar to expressionProperties with a slight difference. You should (hopefully) never notice the difference with the most common use case. This is available due to limitations with expressionProperties and ng-if not working together very nicely.

This allows you to specify the id of your field (which will be used for its name as well unless a name is provided). Note, you can also override the id generation code using the formlyConfig extra called getFieldId.

Can be set instead of type or template to use a custom html template form field. Works just like a directive templateUrl and uses the $templateCache

This allows you to specify a link function. It is invoked after your template has finished compiling. You are passed the normal arguments for a normal link function.

Allows you to take advantage of ng-model-options directive. Formly's built-in templateManipulator (see below) will add this attribute to your ng-model element automatically if this property exists. Note, if you use the getter/setter option, formly's templateManipulator will change the value of ng-model to options.value which is a getterSetter that formly adds to field options.

If you wish to, you can specify a specific name for your ng-model. This is useful if you're posting the form to a server using techniques of yester-year.

This is used by ngModelAttrsTemplateManipulator to automatically add attributes to the ng-model element of field templates. You will likely not use this often. This object is a little complex, but extremely powerful. It's best to explain this api via an example. For more information, see the guide on ngModelAttrs.

This allows you to place attributes with string values on the ng-model element. Easy to use alternative to ngModelAttrs option.

Used to tell angular-formly to not attempt to add the formControl property to your object. This is useful for things like validation, but not necessary if your "field" doesn't use ng-model (if it's just a horizontal line for example). Defaults to undefined.

Allows you to specify extra types to get options from. Duplicate options are overridden in later priority (index 1 will override index 0 properties). Also, these are applied after the type's defaultOptions and hence will override any duplicates of those properties as well.

Will reset the field's model and the field control to the last initialValue. This is used by the formly-form's options.resetModel function.

It is not likely that you'll ever want to invoke this function. It simply runs the expressionProperties expressions. It is used internally and you shouldn't have to use it, but you can if you want to, and any breaking changes to the way it works will result in a major version change, so you can rely on its api.

Can be set instead of type or templateUrl to use a custom html template form field. Recommended to be used with one-liners mostly (like a directive), or if you're using webpack with the ability to require templates :-)

Allows you to specify custom template manipulators for this specific field. (use defaultOptions in a type configuration if you want it to apply to all fields of a certain type).

This is reserved for the templates. Any template-specific options go in here. Look at your specific template implementation to know the options required for this.

Can be set instead of type or template to use a custom html template form field. Works just like a directive templateUrl and uses the $templateCache

The type of field to be rendered. This is the recommended method for defining fields. Types must be pre-defined using formlyConfig.

Will reset the field's initialValue to the current state of the model. Useful if you load the model asynchronously. Invoke this when the model gets set. This is used by the formly-form's options.updateInitialValue function.

An object with a few useful properties mostly handy when used in combination with ng-messages

An object where the keys are the name of the validator and the values are Formly Expressions;

An object which has at least two properties called expression and listener. The watch.expression is added to the formly-form directive's scope (to allow it to run even when hide is true). You can specify a type ($watchCollection or $watchGroup) via the watcher.type property (defaults to $watch) and whether you want it to be a deep watch via the watcher.deep property (defaults to false).

This makes reference to setWrapper in formlyConfig. It is expected to be the name of the wrapper. If given an array, the formly field template will be wrapped by the first wrapper, then the second, then the third, etc. You can also specify these as part of a type (which is the recommended approach). Specifying this property will override the wrappers for the type for this field.