Filter

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

Fields

A filter contains the following fields to be defined:

FormControls

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

Requirements Rules:

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

Example:

Filter:
  FormControls: [ My_Property_1, My_Property_2, ...]

---

SubmitButtonLabel

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

Requirements Rules:

• Max length of 30 chars

Example:

Filter:
  FormControls: [ My_Property_1, My_Property_2, ...]
  SubmitButtonLabel: 'Search entities'

---

SubmitButtonStyle

The style that should be applied to filter-component submit button. Defaults to 'basic' 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:

Filter:
  FormControls: [ My_Property_1, My_Property_2, ...]
  SubmitButtonLabel: 'Search entities'
  SubmitButtonStyle: accent

---

AsAdditionalFields

Subset list of 'FormControls' that should be rendered behind the expansion panel in the filter-component. All form controls are rendered, those marked as additional fields will be displayed only when user expands the filter-component panel.

These fields are rendered in visual interfaces like optional fields for filter request. The 'AsAdditionalFields' property intent is to be used when filter-component contains many fields.

Requirements Rules:

• Must be an value present at FormControls property of the Filter;

Example:

Filter:
  FormControls: [ My_Property_1, My_Property_2, ...]
  SubmitButtonLabel: 'Search entities'
  SubmitButtonStyle: accent
  AsAdditionalFields: [ My_Property_2 ]

---