Skip to content

EditForm

With the 'EditForm' section you will be able to register all information needed to render the register form-component.

Fields

A editform contains the following fields to be defined:

FormControls

The list of the controls of the UiStructure that should be rendered in the form-component.

Requirements Rules:

  • Is Required;
  • The name must exist in the Controls list for the uistructure business model

Example:

1
2
EditForm:
  FormControls: [ My_Property_1, My_Property_2, ...]


SubmitButtonLabel

The label that will be rendered for form form-component submit button. Defaults to 'Save' if not informed.

Requirements Rules:

  • Max length of 30 chars

Example:

1
2
3
EditForm:
  FormControls: [ My_Property_1, My_Property_2, ...]
  SubmitButtonLabel: 'Save entity'


SubmitButtonStyle

The style that should be applied to form-component submit button. Defaults to 'primary' if not informed.

Possible types are:

  • basic;
  • primary;
  • accent;
  • warn;

Requirements Rules:

  • Must be an Allowed valid type, according to the types informed above

Example:

1
2
3
4
EditForm:
  FormControls: [ My_Property_1, My_Property_2, ...]
  SubmitButtonLabel: 'Save entity'
  SubmitButtonStyle: primary


Validations

The list of entity-validations from business model, that should be used to render form validations. All validations rendered are performed before the submit of data, providing a simple way to validate data before perform a backend request.

Note

Some validation rules applied at Entity Validations can not be performed at front-end (e.g.: IsValidation), in this case these validations are ignored. Consider these limitations in case you plan to use the same backend validation rules at front-end.

Requirements Rules:

  • The name must exist in EntityValidations list in the current model;

Example:

1
2
3
4
5
6
Filter:
  FormControls: [ My_Property_1, My_Property_2, ...]
  SubmitButtonLabel: 'Search entities'
  SubmitButtonStyle: accent
  Validations:
  - My_Entity_Validation_1


Back to top