Interfaces

ResultsOptions

Version:


Type	Interface
Import path	`@sitecore-cloudsdk/search/browser`

The results object of a widget item.

Signature

export interface WidgetItemRecommendation {
  content?: ContentOptions;
  filter?: Filter;
  groupBy?: string;
  limit?: number;
  rule?: SearchRuleOptions;
}

Properties

Name	Type	Description	Value
`content`	`ContentOptions`	Optional. The content options property of the results widget item. Used to select the attributes to request for each item. For example, to request only the `title` and `description` attributes.	N/A
`filter`	`Filter`	Optional. Various filter criteria that can be used to filter the content to be returned.	N/A
`groupBy`	`string`	Optional. The attribute to group or collapse results by. The attribute must be defined in Sitecore Search. For example, group recommendations by color or country.	`"group_id"`
`limit`	`integer`	Optional. The number to set as the results limit. Used for pagination by specifying the maximum number of results to return. Minimum: `1`. Maximum: `100`.	`25`
`rule`	`SearchRuleOptions`	Optional. Options for rules. Rules are modifications to widget behavior that can be used to overwrite the natural set of search results, for example, to boost, bury, pin, and blacklist items.	N/A

If you have suggestions for improving this article, let us know!