Skip to content

CrudParams

With the 'CrudParams' section, you will be able to configure and build a set of crud components.

Fields

A CrudParams contains the following fields to be defined:

Controls

The list of control information which will be used to render ui form controls.

Requirements Rules:

  • Must haven't duplicated control properties;
  • Each control on list must follows rules as specified in Control

Example: 

1
2
3
4
5
6
CrudParams:
  Controls:
  - Property: My_Entity_Prop_1
  ...
  - Property: My_Entity_Prop_2
  ...

Filter

The properties which will be used to render the filter-component. The filter-component is a simple form component which emits a filter-request when the form is submitted.

Requirements Rules:

Example: 

1
2
3
4
5
6
7
8
9
CrudParams:
  Controls:
  - Property: My_Entity_Prop_1
  ...
  - Property: My_Entity_Prop_2
  ...
  Filter:
    FormControls: [...]
    ...

Grid

The properties which will be used to render the grid-component. The grid-component is a simple component which renders a list of objects in a table from a custom-made source. The component allows sorting and a few extra actions per register (Edit / Remove).

Requirements Rules:

Example: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
CrudParams:
  Controls:
  - Property: My_Entity_Prop_1
  ...
  - Property: My_Entity_Prop_2
  ...
  Filter:
    FormControls: [...]
    ...
  Grid:
    Fields:
    ...

EditForm

The properties which will be used to render the register form-component. The register form-component allows you to register a new entity, delete and even change it's data, the validation rules can be linked to existing entity-validations at business model.

Requirements Rules:

Example: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
CrudParams:
  Controls:
  - Property: My_Entity_Prop_1
  ...
  - Property: My_Entity_Prop_2
  ...
  Filter:
    FormControls: [...]
    ...
  Grid:
    Fields:
    ...
  EditForm:
    FormControls: [...]

Back to top