Appearance
SearchResultSortField ​
The component SearchResultSortField shows the current sort field and allows the selection of another sort field.
Properties ​
HTMLElementBaseComponent
Element tag:
cm4ap-search-result-sort-field
Parameter ​
Parameters in the Layout ​
| Name | Type | Description |
|---|---|---|
| hideByEmptyResult | boolean default: false | Defines whether the component should be hidden if the search contains no results. |
| searchActor | SearchActor | The actor is required to get and set the sort field. |
| viewStackToggleActor | LabeledToggleActor | The actor is required to get the current state name to determine if the component needs to be hidden. |
| hideForViews | array of string default: ["grid", "timeline"] | The state names for which the component must be hidden. |
| searchSetActor | SearchSetActor | The actor provides the sorting fields. |
| sortFieldOptions | array of (string or FieldOptions) | The field names or information of sortable fields. |
Field Options ​
| Name | Type | Description |
|---|---|---|
| field (required) | string | Field name |
| label (required) | string | Text or label key |
| translate (optional) | boolean | Defines whether the text should be translated. |
Limitation: List-fields are not supported and should not be used.