1. Interfaces

QueryOptions

Version:
TypeInterface
Import path@sitecore-cloudsdk/search/browser

The query object of the search widget item. Settings related to the site visitor's search query.

Signature

export interface QueryOptions {
  keyphrase: string;
  operator?: Exclude<LogicalOperators, 'not'>;
}

Properties

NameTypeDescriptionValue
keyphrasestringRequired.The text the site visitor enters in the search field to perform a search.Minimum length: 1.Maximum length: 100."athletic sneakers"
operatorLogicalOperatorsOptional.Logical operators to use for multi-word keyphrases.Must be one of:"and""or""and"
If you have suggestions for improving this article, let us know!