@bridgeline-digital/hawksearch-handlebars-ui 6.2.1 → 6.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/changelog.md +8 -0
- package/docs/assets/custom.css +25 -0
- package/docs/assets/highlight.css +134 -0
- package/docs/assets/main.js +58 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1367 -0
- package/docs/classes/Components.AutocompleteComponent.html +385 -0
- package/docs/classes/Components.BaseComponent.html +307 -0
- package/docs/classes/Components.BaseContentComponent.html +288 -0
- package/docs/classes/Components.BaseFacetComponent.html +359 -0
- package/docs/classes/Components.CheckboxListFacetComponent.html +334 -0
- package/docs/classes/Components.ColorFacetComponent.html +317 -0
- package/docs/classes/Components.ConceptSearchFieldComponent.html +339 -0
- package/docs/classes/Components.ContentZoneComponent.html +357 -0
- package/docs/classes/Components.ConversationalSearchComponent.html +377 -0
- package/docs/classes/Components.CustomContentComponent.html +309 -0
- package/docs/classes/Components.DatePickerComponent.html +523 -0
- package/docs/classes/Components.DateRangeFacetComponent.html +333 -0
- package/docs/classes/Components.FacetWrapperComponent.html +355 -0
- package/docs/classes/Components.FacetsListComponent.html +323 -0
- package/docs/classes/Components.FeaturedItemsContentComponent.html +309 -0
- package/docs/classes/Components.FeaturedItemsContentItemComponent.html +345 -0
- package/docs/classes/Components.IconComponent.html +350 -0
- package/docs/classes/Components.ImageContentComponent.html +309 -0
- package/docs/classes/Components.ImageSearchFieldComponent.html +340 -0
- package/docs/classes/Components.LandingPageComponent.html +347 -0
- package/docs/classes/Components.LinkListFacetComponent.html +317 -0
- package/docs/classes/Components.ModifiedQueryComponent.html +324 -0
- package/docs/classes/Components.NumericRangeFacetComponent.html +333 -0
- package/docs/classes/Components.PageSizeComponent.html +324 -0
- package/docs/classes/Components.PaginationComponent.html +351 -0
- package/docs/classes/Components.PopularQueriesContentComponent.html +309 -0
- package/docs/classes/Components.QuerySuggestionsComponent.html +337 -0
- package/docs/classes/Components.RangeSliderComponent.html +381 -0
- package/docs/classes/Components.RangeSliderFacetComponent.html +333 -0
- package/docs/classes/Components.RatingComponent.html +343 -0
- package/docs/classes/Components.RecentSearchesFacetComponent.html +329 -0
- package/docs/classes/Components.RecommendationsComponent.html +435 -0
- package/docs/classes/Components.RecommendationsItemComponent.html +337 -0
- package/docs/classes/Components.RelatedSearchesFacetComponent.html +329 -0
- package/docs/classes/Components.SearchFieldComponent.html +341 -0
- package/docs/classes/Components.SearchResultsComponent.html +349 -0
- package/docs/classes/Components.SearchResultsItemComponent.html +337 -0
- package/docs/classes/Components.SearchResultsListComponent.html +309 -0
- package/docs/classes/Components.SearchWithinFacetComponent.html +329 -0
- package/docs/classes/Components.SelectedFacetsComponent.html +327 -0
- package/docs/classes/Components.SizeFacetComponent.html +317 -0
- package/docs/classes/Components.SmartResponseComponent.html +346 -0
- package/docs/classes/Components.SortingComponent.html +323 -0
- package/docs/classes/Components.TabsComponent.html +323 -0
- package/docs/classes/Components.TooltipComponent.html +327 -0
- package/docs/classes/Components.VariantSelectorComponent.html +309 -0
- package/docs/classes/Components.VisualSearchFieldComponent.html +327 -0
- package/docs/classes/Services.AutocompleteService.html +393 -0
- package/docs/classes/Services.BaseService.html +351 -0
- package/docs/classes/Services.ConversationalService.html +400 -0
- package/docs/classes/Services.RecommendationsService.html +393 -0
- package/docs/classes/Services.SearchService.html +779 -0
- package/docs/classes/Services.TrackingService.html +565 -0
- package/docs/enums/Models.AutocompleteItemType.html +197 -0
- package/docs/enums/Models.EventType.html +232 -0
- package/docs/enums/Models.PageType.html +202 -0
- package/docs/enums/Models.SearchType.html +187 -0
- package/docs/functions/Helpers.add.html +97 -0
- package/docs/functions/Helpers.and.html +92 -0
- package/docs/functions/Helpers.arrayFilterObjects.html +93 -0
- package/docs/functions/Helpers.arrayHasObjectsWithValue.html +93 -0
- package/docs/functions/Helpers.attribute.html +97 -0
- package/docs/functions/Helpers.concat.html +92 -0
- package/docs/functions/Helpers.currency.html +93 -0
- package/docs/functions/Helpers.decode.html +83 -0
- package/docs/functions/Helpers.decodeNested.html +83 -0
- package/docs/functions/Helpers.eq.html +88 -0
- package/docs/functions/Helpers.escapeRegExp.html +80 -0
- package/docs/functions/Helpers.exclude.html +92 -0
- package/docs/functions/Helpers.gt.html +88 -0
- package/docs/functions/Helpers.gte.html +88 -0
- package/docs/functions/Helpers.html.html +83 -0
- package/docs/functions/Helpers.ifElse.html +102 -0
- package/docs/functions/Helpers.lt.html +88 -0
- package/docs/functions/Helpers.lte.html +88 -0
- package/docs/functions/Helpers.number.html +93 -0
- package/docs/functions/Helpers.or.html +83 -0
- package/docs/functions/Helpers.string.html +88 -0
- package/docs/functions/Helpers.subtract.html +88 -0
- package/docs/index.html +175 -0
- package/docs/interfaces/Configuration.AutocompleteComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.BaseComponentConfig.html +179 -0
- package/docs/interfaces/Configuration.Breakpoints.html +139 -0
- package/docs/interfaces/Configuration.CheckboxListFacetComponentConfig.html +164 -0
- package/docs/interfaces/Configuration.ColorFacetComponentConfig.html +160 -0
- package/docs/interfaces/Configuration.ContentZoneComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.ConversationalSearchComponentConfig.html +192 -0
- package/docs/interfaces/Configuration.CustomContentComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.DatePickerComponentConfig.html +157 -0
- package/docs/interfaces/Configuration.DateRangeFacetComponentConfig.html +151 -0
- package/docs/interfaces/Configuration.FacetWrapperComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.FacetsListComponentConfig.html +149 -0
- package/docs/interfaces/Configuration.FeaturedItemsContentComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.FeaturedItemsContentItemComponentConfig.html +149 -0
- package/docs/interfaces/Configuration.FieldMappings.html +215 -0
- package/docs/interfaces/Configuration.HawkSearchComponents.html +334 -0
- package/docs/interfaces/Configuration.HawkSearchConfig.html +532 -0
- package/docs/interfaces/Configuration.HawkSearchGlobal.html +180 -0
- package/docs/interfaces/Configuration.HawkSearchState.html +124 -0
- package/docs/interfaces/Configuration.IconComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.ImageContentComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.LandingPageComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.LinkListFacetComponentConfig.html +151 -0
- package/docs/interfaces/Configuration.ModifiedQueryComponentConfig.html +151 -0
- package/docs/interfaces/Configuration.NumericRangeFacetComponentConfig.html +151 -0
- package/docs/interfaces/Configuration.PageSizeComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.PaginationComponentConfig.html +157 -0
- package/docs/interfaces/Configuration.PopularQueriesContentComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.QuerySuggestionsComponentConfig.html +151 -0
- package/docs/interfaces/Configuration.RangeSliderComponentConfig.html +151 -0
- package/docs/interfaces/Configuration.RangeSliderFacetComponentConfig.html +151 -0
- package/docs/interfaces/Configuration.RatingComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.RecentSearchesFacetComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.RecommendationsComponentConfig.html +184 -0
- package/docs/interfaces/Configuration.RecommendationsItemComponentConfig.html +149 -0
- package/docs/interfaces/Configuration.RelatedSearchesFacetComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.SearchFieldComponentConfig.html +161 -0
- package/docs/interfaces/Configuration.SearchResultsComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.SearchResultsItemComponentConfig.html +149 -0
- package/docs/interfaces/Configuration.SearchResultsListComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.SearchWithinFacetComponentConfig.html +149 -0
- package/docs/interfaces/Configuration.SelectedFacetsComponentConfig.html +149 -0
- package/docs/interfaces/Configuration.SizeFacetComponentConfig.html +160 -0
- package/docs/interfaces/Configuration.SmartResponseComponentConfig.html +190 -0
- package/docs/interfaces/Configuration.SmartSearchFieldComponentConfig.html +188 -0
- package/docs/interfaces/Configuration.SortingComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.TabsComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.TooltipComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.VariantFieldMappings.html +267 -0
- package/docs/interfaces/Configuration.VariantSelectorComponentConfig.html +139 -0
- package/docs/interfaces/Configuration.VisualSearchFieldComponentConfig.html +183 -0
- package/docs/interfaces/Models.AutocompleteCategories.html +191 -0
- package/docs/interfaces/Models.AutocompleteCategory.html +201 -0
- package/docs/interfaces/Models.AutocompleteComponentModel.html +243 -0
- package/docs/interfaces/Models.AutocompleteContent.html +196 -0
- package/docs/interfaces/Models.AutocompleteContentResult.html +211 -0
- package/docs/interfaces/Models.AutocompleteProductResult.html +271 -0
- package/docs/interfaces/Models.AutocompleteProducts.html +196 -0
- package/docs/interfaces/Models.AutocompleteQueries.html +191 -0
- package/docs/interfaces/Models.AutocompleteQuery.html +191 -0
- package/docs/interfaces/Models.AutocompleteRequest.html +186 -0
- package/docs/interfaces/Models.AutocompleteResponse.html +228 -0
- package/docs/interfaces/Models.BaseComponentModel.html +210 -0
- package/docs/interfaces/Models.CalendarDay.html +206 -0
- package/docs/interfaces/Models.CheckboxListFacetComponentModel.html +231 -0
- package/docs/interfaces/Models.CheckboxListFacetValue.html +252 -0
- package/docs/interfaces/Models.ColorFacetComponentModel.html +217 -0
- package/docs/interfaces/Models.ColorFacetValue.html +242 -0
- package/docs/interfaces/Models.ContentConfiguration.html +196 -0
- package/docs/interfaces/Models.ContentType.html +217 -0
- package/docs/interfaces/Models.ContentZone.html +191 -0
- package/docs/interfaces/Models.ContentZoneComponentModel.html +195 -0
- package/docs/interfaces/Models.ContentZoneItem.html +196 -0
- package/docs/interfaces/Models.ContentZones.html +170 -0
- package/docs/interfaces/Models.ConversationalSearchComponentModel.html +208 -0
- package/docs/interfaces/Models.CustomContent.html +226 -0
- package/docs/interfaces/Models.CustomContentComponentModel.html +226 -0
- package/docs/interfaces/Models.CustomWidgetContent.html +224 -0
- package/docs/interfaces/Models.DateFacetRange.html +213 -0
- package/docs/interfaces/Models.DatePickerComponentModel.html +243 -0
- package/docs/interfaces/Models.DateRangeFacetComponentModel.html +215 -0
- package/docs/interfaces/Models.Facet.html +258 -0
- package/docs/interfaces/Models.FacetScrolling.html +191 -0
- package/docs/interfaces/Models.FacetSearch.html +186 -0
- package/docs/interfaces/Models.FacetTruncation.html +186 -0
- package/docs/interfaces/Models.FacetValue.html +231 -0
- package/docs/interfaces/Models.FacetValueColor.html +196 -0
- package/docs/interfaces/Models.FacetWrapperComponentModel.html +284 -0
- package/docs/interfaces/Models.FacetsListComponentModel.html +203 -0
- package/docs/interfaces/Models.FeaturedItemsContent.html +226 -0
- package/docs/interfaces/Models.FeaturedItemsContentComponentModel.html +226 -0
- package/docs/interfaces/Models.FeaturedItemsContentItem.html +276 -0
- package/docs/interfaces/Models.FeaturedItemsContentItemComponentModel.html +290 -0
- package/docs/interfaces/Models.IconComponentModel.html +203 -0
- package/docs/interfaces/Models.ImageContent.html +251 -0
- package/docs/interfaces/Models.ImageContentComponentModel.html +252 -0
- package/docs/interfaces/Models.Item.html +251 -0
- package/docs/interfaces/Models.ItemVariant.html +252 -0
- package/docs/interfaces/Models.LandingPageComponentModel.html +279 -0
- package/docs/interfaces/Models.LinkListFacetComponentModel.html +218 -0
- package/docs/interfaces/Models.LinkListFacetValue.html +242 -0
- package/docs/interfaces/Models.MessageItem.html +191 -0
- package/docs/interfaces/Models.MessageItemList.html +1417 -0
- package/docs/interfaces/Models.ModifiedQueryComponentModel.html +205 -0
- package/docs/interfaces/Models.ModifiedQueryData.html +196 -0
- package/docs/interfaces/Models.NumericFacetRange.html +213 -0
- package/docs/interfaces/Models.NumericRangeFacetComponentModel.html +215 -0
- package/docs/interfaces/Models.PageSizeComponentModel.html +188 -0
- package/docs/interfaces/Models.Pagination.html +221 -0
- package/docs/interfaces/Models.PaginationComponentModel.html +266 -0
- package/docs/interfaces/Models.PaginationOption.html +201 -0
- package/docs/interfaces/Models.PopularQueriesContent.html +226 -0
- package/docs/interfaces/Models.PopularQueriesContentComponentModel.html +226 -0
- package/docs/interfaces/Models.PopularQueriesContentItem.html +196 -0
- package/docs/interfaces/Models.QuerySuggestionsComponentModel.html +188 -0
- package/docs/interfaces/Models.QuerySuggestionsData.html +191 -0
- package/docs/interfaces/Models.RangeSliderComponentModel.html +205 -0
- package/docs/interfaces/Models.RangeSliderEventData.html +191 -0
- package/docs/interfaces/Models.RangeSliderFacetComponentModel.html +225 -0
- package/docs/interfaces/Models.RatingComponentModel.html +188 -0
- package/docs/interfaces/Models.RecentSearchesFacetComponentModel.html +188 -0
- package/docs/interfaces/Models.RecommendationsComponentModel.html +263 -0
- package/docs/interfaces/Models.RecommendationsItem.html +263 -0
- package/docs/interfaces/Models.RecommendationsItemComponentModel.html +272 -0
- package/docs/interfaces/Models.RecommendationsRequest.html +196 -0
- package/docs/interfaces/Models.RecommendationsResponse.html +191 -0
- package/docs/interfaces/Models.RecommendationsWidget.html +208 -0
- package/docs/interfaces/Models.Redirect.html +191 -0
- package/docs/interfaces/Models.RelatedSearchesFacetComponentModel.html +188 -0
- package/docs/interfaces/Models.SearchFieldComponentModel.html +198 -0
- package/docs/interfaces/Models.SearchRequest.html +231 -0
- package/docs/interfaces/Models.SearchResponse.html +259 -0
- package/docs/interfaces/Models.SearchResultsComponentModel.html +274 -0
- package/docs/interfaces/Models.SearchResultsItem.html +278 -0
- package/docs/interfaces/Models.SearchResultsItemComponentModel.html +292 -0
- package/docs/interfaces/Models.SearchResultsItemVariant.html +264 -0
- package/docs/interfaces/Models.SearchResultsListComponentModel.html +188 -0
- package/docs/interfaces/Models.SearchWithinFacetComponentModel.html +198 -0
- package/docs/interfaces/Models.SelectedFacet.html +201 -0
- package/docs/interfaces/Models.SelectedFacetValue.html +196 -0
- package/docs/interfaces/Models.SelectedFacetsComponentModel.html +211 -0
- package/docs/interfaces/Models.SeoConfiguration.html +206 -0
- package/docs/interfaces/Models.SizeFacetComponentModel.html +217 -0
- package/docs/interfaces/Models.SizeFacetValue.html +242 -0
- package/docs/interfaces/Models.SmartResponseComponentModel.html +215 -0
- package/docs/interfaces/Models.SmartResponseRequest.html +191 -0
- package/docs/interfaces/Models.SmartResponseResponse.html +196 -0
- package/docs/interfaces/Models.SmartSearchFieldComponentModel.html +213 -0
- package/docs/interfaces/Models.Sorting.html +191 -0
- package/docs/interfaces/Models.SortingComponentModel.html +188 -0
- package/docs/interfaces/Models.SortingOption.html +201 -0
- package/docs/interfaces/Models.TabsComponentModel.html +193 -0
- package/docs/interfaces/Models.TooltipComponentModel.html +188 -0
- package/docs/interfaces/Models.VariantSelectorComponentModel.html +193 -0
- package/docs/interfaces/Models.Variants.html +191 -0
- package/docs/interfaces/Models.VisualSearchFieldComponentModel.html +204 -0
- package/docs/interfaces/Services.ServiceFieldMappings.html +115 -0
- package/docs/interfaces/Services.ServiceVariantFieldMappings.html +129 -0
- package/docs/modules/Components.html +494 -0
- package/docs/modules/Configuration.html +156 -0
- package/docs/modules/Helpers.html +93 -0
- package/docs/modules/Models.html +305 -0
- package/docs/modules/Services.html +68 -0
- package/docs/types/Configuration.DisplayType.html +97 -0
- package/docs/types/Models.FacetState.html +178 -0
- package/docs/types/Models.FacetType.html +165 -0
- package/docs/types/Models.FacetValueState.html +170 -0
- package/docs/types/Models.IconName.html +165 -0
- package/docs/types/Models.ItemType.html +165 -0
- package/docs/types/Models.MessageRole.html +165 -0
- package/docs/types/Models.RequestType.html +165 -0
- package/docs/types/Models.SearchResultsMode.html +165 -0
- package/docs/types/Models.SearchTypes.html +172 -0
- package/docs/types/Models.SelectedFacets.html +165 -0
- package/package.json +1 -1
|
@@ -0,0 +1,532 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HawkSearchConfig | @bridgeline-digital/hawksearch-handlebars-ui</title><meta name="description" content="Documentation for @bridgeline-digital/hawksearch-handlebars-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container">
|
|
3
|
+
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
+
<div class="field">
|
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
+
<ul class="results">
|
|
8
|
+
<li class="state loading">Preparing search index...</li>
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bridgeline-digital/hawksearch-handlebars-ui</a></div>
|
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
+
<div class="container container-main">
|
|
12
|
+
<div class="col-content">
|
|
13
|
+
<div class="tsd-page-title">
|
|
14
|
+
<ul class="tsd-breadcrumb">
|
|
15
|
+
<li><a href="../index.html">@bridgeline-digital/hawksearch-handlebars-ui</a></li>
|
|
16
|
+
<li><a href="../modules/Configuration.html">Configuration</a></li>
|
|
17
|
+
<li><a href="Configuration.HawkSearchConfig.html">HawkSearchConfig</a></li></ul>
|
|
18
|
+
<h1>Interface HawkSearchConfig</h1></div>
|
|
19
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
20
|
+
<h4>Hierarchy</h4>
|
|
21
|
+
<ul class="tsd-hierarchy">
|
|
22
|
+
<li><span class="target">HawkSearchConfig</span></li></ul></section>
|
|
23
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
24
|
+
<section class="tsd-panel tsd-index-panel">
|
|
25
|
+
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
26
|
+
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
27
|
+
<div class="tsd-accordion-details">
|
|
28
|
+
<section class="tsd-index-section">
|
|
29
|
+
<h3 class="tsd-index-heading">Properties</h3>
|
|
30
|
+
<div class="tsd-index-list"><a href="Configuration.HawkSearchConfig.html#autocomplete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>autocomplete?</span></a>
|
|
31
|
+
<a href="Configuration.HawkSearchConfig.html#breakpoints" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>breakpoints?</span></a>
|
|
32
|
+
<a href="Configuration.HawkSearchConfig.html#clientId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>client<wbr/>Id</span></a>
|
|
33
|
+
<a href="Configuration.HawkSearchConfig.html#components" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>components?</span></a>
|
|
34
|
+
<a href="Configuration.HawkSearchConfig.html#css" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>css?</span></a>
|
|
35
|
+
<a href="Configuration.HawkSearchConfig.html#debug" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>debug?</span></a>
|
|
36
|
+
<a href="Configuration.HawkSearchConfig.html#fieldMappings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>field<wbr/>Mappings?</span></a>
|
|
37
|
+
<a href="Configuration.HawkSearchConfig.html#formatting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>formatting?</span></a>
|
|
38
|
+
<a href="Configuration.HawkSearchConfig.html#index" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>index?</span></a>
|
|
39
|
+
<a href="Configuration.HawkSearchConfig.html#placeholderImageUrl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>placeholder<wbr/>Image<wbr/>Url?</span></a>
|
|
40
|
+
<a href="Configuration.HawkSearchConfig.html#recommendations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>recommendations?</span></a>
|
|
41
|
+
<a href="Configuration.HawkSearchConfig.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>search?</span></a>
|
|
42
|
+
<a href="Configuration.HawkSearchConfig.html#seo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>seo?</span></a>
|
|
43
|
+
<a href="Configuration.HawkSearchConfig.html#shadowDom" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>shadow<wbr/>Dom?</span></a>
|
|
44
|
+
<a href="Configuration.HawkSearchConfig.html#tracking" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tracking?</span></a>
|
|
45
|
+
<a href="Configuration.HawkSearchConfig.html#urlPrefixes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>url<wbr/>Prefixes?</span></a>
|
|
46
|
+
<a href="Configuration.HawkSearchConfig.html#variants" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>variants?</span></a>
|
|
47
|
+
</div></section></div></details></section></section>
|
|
48
|
+
<section class="tsd-panel-group tsd-member-group">
|
|
49
|
+
<h2>Properties</h2>
|
|
50
|
+
<section class="tsd-panel tsd-member"><a id="autocomplete" class="tsd-anchor"></a>
|
|
51
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>autocomplete</span><a href="#autocomplete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
52
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autocomplete</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">decodeQuery</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">endpointUrl</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">minCharacterCount</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">recommendationsEnabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
53
|
+
<div class="tsd-type-declaration">
|
|
54
|
+
<h4>Type declaration</h4>
|
|
55
|
+
<ul class="tsd-parameters">
|
|
56
|
+
<li class="tsd-parameter">
|
|
57
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">decode<wbr/>Query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
58
|
+
<div class="tsd-comment tsd-typography"><p>Whether to automatically URI decode the search query value. Runs recursively until value is fully decoded. For example, <code>Test%2520Value</code> would become <code>Test Value</code>.</p>
|
|
59
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>true</code></p>
|
|
60
|
+
</div>
|
|
61
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
62
|
+
<li class="tsd-parameter">
|
|
63
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">endpoint<wbr/>Url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
64
|
+
<div class="tsd-comment tsd-typography"><p>The API used to retrieve search results</p>
|
|
65
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'https://searchapi-dev.hawksearch.net'</code></p>
|
|
66
|
+
</div>
|
|
67
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
68
|
+
<li class="tsd-parameter">
|
|
69
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">min<wbr/>Character<wbr/>Count</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
|
70
|
+
<div class="tsd-comment tsd-typography"><p>Specifies the minimum length for a query to trigger an autocomplete recommendations request.</p>
|
|
71
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>1</code></p>
|
|
72
|
+
</div>
|
|
73
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
74
|
+
<li class="tsd-parameter">
|
|
75
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">recommendations<wbr/>Enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
76
|
+
<div class="tsd-comment tsd-typography"><p>Specifies whether autocomplete recommendations (autocomplete without entering a query - "instant engage") is enabled</p>
|
|
77
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>false</code></p>
|
|
78
|
+
</div>
|
|
79
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div></section>
|
|
80
|
+
<section class="tsd-panel tsd-member"><a id="breakpoints" class="tsd-anchor"></a>
|
|
81
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>breakpoints</span><a href="#breakpoints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
82
|
+
<div class="tsd-signature"><span class="tsd-kind-property">breakpoints</span><span class="tsd-signature-symbol">?:</span> <a href="Configuration.Breakpoints.html" class="tsd-signature-type tsd-kind-interface">Breakpoints</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></div>
|
|
83
|
+
<div class="tsd-comment tsd-typography"><p>Specifies the minimum window widths that correspond to each breakpoint. This is used determine when certain content items are displayed.</p>
|
|
84
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><pre><code class="language-js"><span class="hl-2">{</span><br/><span class="hl-2"> </span><span class="hl-15">mobile</span><span class="hl-2">: </span><span class="hl-8">undefined</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-15">tablet</span><span class="hl-2">: </span><span class="hl-14">740</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-15">desktop</span><span class="hl-2">: </span><span class="hl-14">990</span><br/><span class="hl-2">}</span>
|
|
85
|
+
</code><button>Copy</button></pre>
|
|
86
|
+
</div>
|
|
87
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
88
|
+
<section class="tsd-panel tsd-member"><a id="clientId" class="tsd-anchor"></a>
|
|
89
|
+
<h3 class="tsd-anchor-link"><span>client<wbr/>Id</span><a href="#clientId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
90
|
+
<div class="tsd-signature"><span class="tsd-kind-property">client<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
91
|
+
<div class="tsd-comment tsd-typography"><p>The unique ID for your installation found in the HawkSearch admin</p>
|
|
92
|
+
</div>
|
|
93
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
94
|
+
<section class="tsd-panel tsd-member"><a id="components" class="tsd-anchor"></a>
|
|
95
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
96
|
+
<div class="tsd-signature"><span class="tsd-kind-property">components</span><span class="tsd-signature-symbol">?:</span> <a href="Configuration.HawkSearchComponents.html" class="tsd-signature-type tsd-kind-interface">HawkSearchComponents</a></div>
|
|
97
|
+
<div class="tsd-comment tsd-typography"><p>Specifies component-specific configuration options</p>
|
|
98
|
+
</div>
|
|
99
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
100
|
+
<section class="tsd-panel tsd-member"><a id="css" class="tsd-anchor"></a>
|
|
101
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>css</span><a href="#css" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
102
|
+
<div class="tsd-signature"><span class="tsd-kind-property">css</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">customStyles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">defaultStyles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
103
|
+
<div class="tsd-comment tsd-typography"><p>Specifies which styles should be loaded for each component</p>
|
|
104
|
+
</div>
|
|
105
|
+
<div class="tsd-type-declaration">
|
|
106
|
+
<h4>Type declaration</h4>
|
|
107
|
+
<ul class="tsd-parameters">
|
|
108
|
+
<li class="tsd-parameter">
|
|
109
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">custom<wbr/>Styles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
110
|
+
<div class="tsd-comment tsd-typography"><p>One or more style sets to be loaded. This can be either a URL to an external stylesheet, the ID of a <code>template</code> element wrapping around a <code>style</code> element, or a string containing CSS rules.</p>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
113
|
+
<li class="tsd-parameter">
|
|
114
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">default<wbr/>Styles</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
115
|
+
<div class="tsd-comment tsd-typography"><p>Specifies whether the default stylesheet should be loaded. This should generally be true except for with completely custom interfaces.</p>
|
|
116
|
+
</div>
|
|
117
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
118
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
119
|
+
<section class="tsd-panel tsd-member"><a id="debug" class="tsd-anchor"></a>
|
|
120
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
121
|
+
<div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
122
|
+
<div class="tsd-comment tsd-typography"><p>Specifies whether search queries should be displayed on console</p>
|
|
123
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>false</code></p>
|
|
124
|
+
</div>
|
|
125
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
126
|
+
<section class="tsd-panel tsd-member"><a id="fieldMappings" class="tsd-anchor"></a>
|
|
127
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>field<wbr/>Mappings</span><a href="#fieldMappings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
128
|
+
<div class="tsd-signature"><span class="tsd-kind-property">field<wbr/>Mappings</span><span class="tsd-signature-symbol">?:</span> <a href="Configuration.FieldMappings.html" class="tsd-signature-type tsd-kind-interface">FieldMappings</a></div>
|
|
129
|
+
<div class="tsd-comment tsd-typography"><p>Map item attributes to common object properties</p>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
132
|
+
<section class="tsd-panel tsd-member"><a id="formatting" class="tsd-anchor"></a>
|
|
133
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>formatting</span><a href="#formatting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
134
|
+
<div class="tsd-signature"><span class="tsd-kind-property">formatting</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">cultureIsoCode</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">currencyIsoCode</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
135
|
+
<div class="tsd-comment tsd-typography"><p>Specifies how values should be formatted for different cultures</p>
|
|
136
|
+
</div>
|
|
137
|
+
<div class="tsd-type-declaration">
|
|
138
|
+
<h4>Type declaration</h4>
|
|
139
|
+
<ul class="tsd-parameters">
|
|
140
|
+
<li class="tsd-parameter">
|
|
141
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">culture<wbr/>Iso<wbr/>Code</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
142
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'en-US'</code></p>
|
|
143
|
+
</div>
|
|
144
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
145
|
+
<li class="tsd-parameter">
|
|
146
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">currency<wbr/>Iso<wbr/>Code</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
147
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'USD'</code></p>
|
|
148
|
+
</div>
|
|
149
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
150
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
151
|
+
<section class="tsd-panel tsd-member"><a id="index" class="tsd-anchor"></a>
|
|
152
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
153
|
+
<div class="tsd-signature"><span class="tsd-kind-property">index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
154
|
+
<div class="tsd-comment tsd-typography"><p>Specify an index to query rather than the default</p>
|
|
155
|
+
</div>
|
|
156
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
157
|
+
<section class="tsd-panel tsd-member"><a id="placeholderImageUrl" class="tsd-anchor"></a>
|
|
158
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>placeholder<wbr/>Image<wbr/>Url</span><a href="#placeholderImageUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
159
|
+
<div class="tsd-signature"><span class="tsd-kind-property">placeholder<wbr/>Image<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
160
|
+
<div class="tsd-comment tsd-typography"><p>The URL of an image to be loaded whenever an image fails to load for a search result item</p>
|
|
161
|
+
</div>
|
|
162
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
163
|
+
<section class="tsd-panel tsd-member"><a id="recommendations" class="tsd-anchor"></a>
|
|
164
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>recommendations</span><a href="#recommendations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
165
|
+
<div class="tsd-signature"><span class="tsd-kind-property">recommendations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">endpointUrl</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
166
|
+
<div class="tsd-type-declaration">
|
|
167
|
+
<h4>Type declaration</h4>
|
|
168
|
+
<ul class="tsd-parameters">
|
|
169
|
+
<li class="tsd-parameter">
|
|
170
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">endpoint<wbr/>Url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
171
|
+
<div class="tsd-comment tsd-typography"><p>The API used to retrieve product recommendations</p>
|
|
172
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'https://recs-dev.hawksearch.net'</code></p>
|
|
173
|
+
</div>
|
|
174
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div></section>
|
|
175
|
+
<section class="tsd-panel tsd-member"><a id="search" class="tsd-anchor"></a>
|
|
176
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>search</span><a href="#search" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
177
|
+
<div class="tsd-signature"><span class="tsd-kind-property">search</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">decodeFacetValues</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">decodeQuery</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">endpointUrl</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">facetExclusionPrefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">itemTypes</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">: </span><a href="../types/Models.ItemType.html" class="tsd-signature-type tsd-kind-type-alias">ItemType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">productValues</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">kValue</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">queryStringMappings</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">disableSpellcheck</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pageSize</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">requestType</span><span class="tsd-signature-symbol">?: </span><a href="../types/Models.RequestType.html" class="tsd-signature-type tsd-kind-type-alias">RequestType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchWithin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
178
|
+
<div class="tsd-type-declaration">
|
|
179
|
+
<h4>Type declaration</h4>
|
|
180
|
+
<ul class="tsd-parameters">
|
|
181
|
+
<li class="tsd-parameter">
|
|
182
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">decode<wbr/>Facet<wbr/>Values</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
183
|
+
<div class="tsd-comment tsd-typography"><p>Whether to automatically URI decode facet selection values. Runs recursively until value is fully decoded. For example, <code>Test%2520Value</code> would become <code>Test Value</code>.</p>
|
|
184
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>true</code></p>
|
|
185
|
+
</div>
|
|
186
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
187
|
+
<li class="tsd-parameter">
|
|
188
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">decode<wbr/>Query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
189
|
+
<div class="tsd-comment tsd-typography"><p>Whether to automatically URI decode the search query value. Runs recursively until value is fully decoded. For example, <code>Test%2520Value</code> would become <code>Test Value</code>.</p>
|
|
190
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>true</code></p>
|
|
191
|
+
</div>
|
|
192
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
193
|
+
<li class="tsd-parameter">
|
|
194
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">endpoint<wbr/>Url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
195
|
+
<div class="tsd-comment tsd-typography"><p>The API used to retrieve search results</p>
|
|
196
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'https://searchapi-dev.hawksearch.net'</code></p>
|
|
197
|
+
</div>
|
|
198
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
199
|
+
<li class="tsd-parameter">
|
|
200
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">facet<wbr/>Exclusion<wbr/>Prefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
201
|
+
<div class="tsd-comment tsd-typography"><p>The prefix for values sent to the API when excluding a facet. This is only modified in rare circumstances where the project has facet values starting with a hyphen.</p>
|
|
202
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'-'</code></p>
|
|
203
|
+
</div>
|
|
204
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
205
|
+
<li class="tsd-parameter">
|
|
206
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">item<wbr/>Types</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">: </span><a href="../types/Models.ItemType.html" class="tsd-signature-type tsd-kind-type-alias">ItemType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">productValues</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
207
|
+
<div class="tsd-comment tsd-typography"><p>Specifies how search results should be classified</p>
|
|
208
|
+
</div>
|
|
209
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
210
|
+
<ul class="tsd-parameters">
|
|
211
|
+
<li class="tsd-parameter">
|
|
212
|
+
<h5><span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">: </span><a href="../types/Models.ItemType.html" class="tsd-signature-type tsd-kind-type-alias">ItemType</a></h5>
|
|
213
|
+
<div class="tsd-comment tsd-typography"><p>If the value a search result item is missing a value for the field mapped to <a href="Configuration.HawkSearchConfig.html#search" class="tsd-kind-property">fieldMappings.type</a>, this value will be assumed.</p>
|
|
214
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'content'</code></p>
|
|
215
|
+
</div>
|
|
216
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
217
|
+
<li class="tsd-parameter">
|
|
218
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">product<wbr/>Values</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
219
|
+
<div class="tsd-comment tsd-typography"><p>List of values that will be considered a <code>product</code> result.</p>
|
|
220
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>['item', 'product']</code></p>
|
|
221
|
+
</div>
|
|
222
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></li>
|
|
223
|
+
<li class="tsd-parameter">
|
|
224
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">k<wbr/>Value</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
|
225
|
+
<div class="tsd-comment tsd-typography"><p>Specifies a kValue for Concept and Image search</p>
|
|
226
|
+
</div>
|
|
227
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
228
|
+
<li class="tsd-parameter">
|
|
229
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">query<wbr/>String<wbr/>Mappings</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">disableSpellcheck</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pageSize</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">requestType</span><span class="tsd-signature-symbol">?: </span><a href="../types/Models.RequestType.html" class="tsd-signature-type tsd-kind-type-alias">RequestType</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">searchWithin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
230
|
+
<div class="tsd-comment tsd-typography"><p>Specifies which query string parameters are used</p>
|
|
231
|
+
</div>
|
|
232
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
233
|
+
<ul class="tsd-parameters">
|
|
234
|
+
<li class="tsd-parameter">
|
|
235
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">disable<wbr/>Spellcheck</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
236
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'disableSpellcheck'</code></p>
|
|
237
|
+
</div>
|
|
238
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
239
|
+
<li class="tsd-parameter">
|
|
240
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
241
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'page'</code></p>
|
|
242
|
+
</div>
|
|
243
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
244
|
+
<li class="tsd-parameter">
|
|
245
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">page<wbr/>Size</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
246
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'pageSize'</code></p>
|
|
247
|
+
</div>
|
|
248
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
249
|
+
<li class="tsd-parameter">
|
|
250
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
251
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'query'</code></p>
|
|
252
|
+
</div>
|
|
253
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
254
|
+
<li class="tsd-parameter">
|
|
255
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">request<wbr/>Type</span><span class="tsd-signature-symbol">?: </span><a href="../types/Models.RequestType.html" class="tsd-signature-type tsd-kind-type-alias">RequestType</a></h5>
|
|
256
|
+
<div class="tsd-comment tsd-typography"><p>Sets RequestType field to toggle between Keyword search, Image search or Concept search</p>
|
|
257
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'DefaultSearch'</code></p>
|
|
258
|
+
</div>
|
|
259
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
260
|
+
<li class="tsd-parameter">
|
|
261
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">search<wbr/>Within</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
262
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'searchWithin'</code></p>
|
|
263
|
+
</div>
|
|
264
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
265
|
+
<li class="tsd-parameter">
|
|
266
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
267
|
+
<div class="tsd-comment tsd-typography"><a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'sort'</code></p>
|
|
268
|
+
</div>
|
|
269
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></li>
|
|
270
|
+
<li class="tsd-parameter">
|
|
271
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
272
|
+
<div class="tsd-comment tsd-typography"><p>The URL of your search results page. This is used to redirect users after performing a search.</p>
|
|
273
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'/search'</code></p>
|
|
274
|
+
</div>
|
|
275
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div></section>
|
|
276
|
+
<section class="tsd-panel tsd-member"><a id="seo" class="tsd-anchor"></a>
|
|
277
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>seo</span><a href="#seo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
278
|
+
<div class="tsd-signature"><span class="tsd-kind-property">seo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">suffix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
279
|
+
<div class="tsd-type-declaration">
|
|
280
|
+
<h4>Type declaration</h4>
|
|
281
|
+
<ul class="tsd-parameters">
|
|
282
|
+
<li class="tsd-parameter">
|
|
283
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">suffix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
284
|
+
<ul class="tsd-parameters">
|
|
285
|
+
<li class="tsd-parameter">
|
|
286
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
287
|
+
<div class="tsd-comment tsd-typography"><p>Value prepended to title returned from API</p>
|
|
288
|
+
</div>
|
|
289
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
290
|
+
<li class="tsd-parameter">
|
|
291
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">suffix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
292
|
+
<div class="tsd-comment tsd-typography"><p>Value appended to title returned from API</p>
|
|
293
|
+
</div>
|
|
294
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div></section>
|
|
295
|
+
<section class="tsd-panel tsd-member"><a id="shadowDom" class="tsd-anchor"></a>
|
|
296
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>shadow<wbr/>Dom</span><a href="#shadowDom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
297
|
+
<div class="tsd-signature"><span class="tsd-kind-property">shadow<wbr/>Dom</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
298
|
+
<div class="tsd-comment tsd-typography"><p>Specifies whether components should be rendered in the <a href="https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM">Shadow DOM</a>. This is highly recommended to avoid CSS conflicts.</p>
|
|
299
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>true</code></p>
|
|
300
|
+
</div>
|
|
301
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
302
|
+
<section class="tsd-panel tsd-member"><a id="tracking" class="tsd-anchor"></a>
|
|
303
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tracking</span><a href="#tracking" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
304
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tracking</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">endpointUrl</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
305
|
+
<div class="tsd-type-declaration">
|
|
306
|
+
<h4>Type declaration</h4>
|
|
307
|
+
<ul class="tsd-parameters">
|
|
308
|
+
<li class="tsd-parameter">
|
|
309
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
310
|
+
<div class="tsd-comment tsd-typography"><p>Specifies whether user actions should be tracked to provide valuable insights on your search engine performance</p>
|
|
311
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>true</code></p>
|
|
312
|
+
</div>
|
|
313
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
314
|
+
<li class="tsd-parameter">
|
|
315
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">endpoint<wbr/>Url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
316
|
+
<div class="tsd-comment tsd-typography"><p>The API used to track user interactions</p>
|
|
317
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>'https://tracking-dev.hawksearch.net'</code></p>
|
|
318
|
+
</div>
|
|
319
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div></section>
|
|
320
|
+
<section class="tsd-panel tsd-member"><a id="urlPrefixes" class="tsd-anchor"></a>
|
|
321
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url<wbr/>Prefixes</span><a href="#urlPrefixes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
322
|
+
<div class="tsd-signature"><span class="tsd-kind-property">url<wbr/>Prefixes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">assets</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
323
|
+
<div class="tsd-comment tsd-typography"><p>If your data contains relative URLs, these values can be prepended to the values to convert them to absolute URLs</p>
|
|
324
|
+
</div>
|
|
325
|
+
<div class="tsd-type-declaration">
|
|
326
|
+
<h4>Type declaration</h4>
|
|
327
|
+
<ul class="tsd-parameters">
|
|
328
|
+
<li class="tsd-parameter">
|
|
329
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">assets</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li>
|
|
330
|
+
<li class="tsd-parameter">
|
|
331
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
332
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
333
|
+
<section class="tsd-panel tsd-member"><a id="variants" class="tsd-anchor"></a>
|
|
334
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>variants</span><a href="#variants" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
335
|
+
<div class="tsd-signature"><span class="tsd-kind-property">variants</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">baseFacetCountOnVariants</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">fieldMappings</span><span class="tsd-signature-symbol">?: </span><a href="Configuration.VariantFieldMappings.html" class="tsd-signature-type tsd-kind-interface">VariantFieldMappings</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">fieldPrefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">trackUsingVariant</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
336
|
+
<div class="tsd-type-declaration">
|
|
337
|
+
<h4>Type declaration</h4>
|
|
338
|
+
<ul class="tsd-parameters">
|
|
339
|
+
<li class="tsd-parameter">
|
|
340
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">base<wbr/>Facet<wbr/>Count<wbr/>On<wbr/>Variants</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
341
|
+
<div class="tsd-comment tsd-typography"><p>When <code>true</code>, specifies that facet counts should be calculated based on the number of child items rather than the number of parent items</p>
|
|
342
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>false</code></p>
|
|
343
|
+
</div>
|
|
344
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
345
|
+
<li class="tsd-parameter">
|
|
346
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
347
|
+
<div class="tsd-comment tsd-typography"><p>Specifies whether variant logic should be used if data is available</p>
|
|
348
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>true</code></p>
|
|
349
|
+
</div>
|
|
350
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
351
|
+
<li class="tsd-parameter">
|
|
352
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">field<wbr/>Mappings</span><span class="tsd-signature-symbol">?: </span><a href="Configuration.VariantFieldMappings.html" class="tsd-signature-type tsd-kind-interface">VariantFieldMappings</a></h5>
|
|
353
|
+
<div class="tsd-comment tsd-typography"><p>Map item attributes to common object properties</p>
|
|
354
|
+
</div>
|
|
355
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
356
|
+
<li class="tsd-parameter">
|
|
357
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">field<wbr/>Prefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
358
|
+
<div class="tsd-comment tsd-typography"><p>When specified, this prefix is removed from the <code>attributes</code> collection on variant items. For example, if a value of <code>'child_'</code> is used and HawkSearch returns a field named <code>'child_color'</code>, it will be transformed to <code>'color'</code>.</p>
|
|
359
|
+
</div>
|
|
360
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
361
|
+
<li class="tsd-parameter">
|
|
362
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">track<wbr/>Using<wbr/>Variant</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
363
|
+
<div class="tsd-comment tsd-typography"><p>When <code>true</code>, specifies that tracking should use the ID of the selected variant rather than the ID of the parent</p>
|
|
364
|
+
<a id="md:default-value" class="tsd-anchor"></a><h4><a href="#md:default-value">Default Value</a></h4><p><code>false</code></p>
|
|
365
|
+
</div>
|
|
366
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div></section></section></div>
|
|
367
|
+
<div class="col-sidebar">
|
|
368
|
+
<div class="page-menu">
|
|
369
|
+
<div class="tsd-navigation settings">
|
|
370
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
371
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
372
|
+
<div class="tsd-accordion-details">
|
|
373
|
+
<div class="tsd-filter-visibility">
|
|
374
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
375
|
+
<ul id="tsd-filter-options">
|
|
376
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
377
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
378
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
379
|
+
<div class="tsd-theme-toggle">
|
|
380
|
+
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
381
|
+
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
382
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
383
|
+
<div class="tsd-accordion-details">
|
|
384
|
+
<ul>
|
|
385
|
+
<li><a href="#autocomplete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>autocomplete</span></a></li>
|
|
386
|
+
<li>
|
|
387
|
+
<ul>
|
|
388
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
389
|
+
<li>
|
|
390
|
+
<ul>
|
|
391
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
392
|
+
<li>
|
|
393
|
+
<ul>
|
|
394
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
395
|
+
<li>
|
|
396
|
+
<ul>
|
|
397
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li></ul></li></ul></li></ul></li>
|
|
398
|
+
<li><a href="#breakpoints" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>breakpoints</span></a></li>
|
|
399
|
+
<li>
|
|
400
|
+
<ul>
|
|
401
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li>
|
|
402
|
+
<li><a href="#clientId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>client<wbr/>Id</span></a></li>
|
|
403
|
+
<li><a href="#components" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>components</span></a></li>
|
|
404
|
+
<li><a href="#css" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>css</span></a></li>
|
|
405
|
+
<li><a href="#debug" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>debug</span></a></li>
|
|
406
|
+
<li>
|
|
407
|
+
<ul>
|
|
408
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li>
|
|
409
|
+
<li><a href="#fieldMappings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>field<wbr/>Mappings</span></a></li>
|
|
410
|
+
<li><a href="#formatting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>formatting</span></a></li>
|
|
411
|
+
<li>
|
|
412
|
+
<ul>
|
|
413
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
414
|
+
<li>
|
|
415
|
+
<ul>
|
|
416
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li></ul></li>
|
|
417
|
+
<li><a href="#index" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>index</span></a></li>
|
|
418
|
+
<li><a href="#placeholderImageUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>placeholder<wbr/>Image<wbr/>Url</span></a></li>
|
|
419
|
+
<li><a href="#recommendations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>recommendations</span></a></li>
|
|
420
|
+
<li>
|
|
421
|
+
<ul>
|
|
422
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li>
|
|
423
|
+
<li><a href="#search" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>search</span></a></li>
|
|
424
|
+
<li>
|
|
425
|
+
<ul>
|
|
426
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
427
|
+
<li>
|
|
428
|
+
<ul>
|
|
429
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
430
|
+
<li>
|
|
431
|
+
<ul>
|
|
432
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
433
|
+
<li>
|
|
434
|
+
<ul>
|
|
435
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
436
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
437
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
438
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
439
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
440
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
441
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
442
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
443
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
444
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
445
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li></ul></li></ul></li></ul></li>
|
|
446
|
+
<li><a href="#seo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>seo</span></a></li>
|
|
447
|
+
<li><a href="#shadowDom" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>shadow<wbr/>Dom</span></a></li>
|
|
448
|
+
<li>
|
|
449
|
+
<ul>
|
|
450
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li>
|
|
451
|
+
<li><a href="#tracking" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tracking</span></a></li>
|
|
452
|
+
<li>
|
|
453
|
+
<ul>
|
|
454
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
455
|
+
<li>
|
|
456
|
+
<ul>
|
|
457
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li></ul></li>
|
|
458
|
+
<li><a href="#urlPrefixes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>url<wbr/>Prefixes</span></a></li>
|
|
459
|
+
<li><a href="#variants" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>variants</span></a></li>
|
|
460
|
+
<li>
|
|
461
|
+
<ul>
|
|
462
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
463
|
+
<li>
|
|
464
|
+
<ul>
|
|
465
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li>
|
|
466
|
+
<li>
|
|
467
|
+
<ul>
|
|
468
|
+
<li><a href="#md:default-value"><span>Default <wbr/>Value</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
|
|
469
|
+
<div class="site-menu">
|
|
470
|
+
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@bridgeline-<wbr/>digital/hawksearch-<wbr/>handlebars-<wbr/>ui</span></a>
|
|
471
|
+
<ul class="tsd-small-nested-navigation">
|
|
472
|
+
<li><a href="../modules/Components.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Components</span></a></li>
|
|
473
|
+
<li>
|
|
474
|
+
<details class="tsd-index-accordion" open data-key="Configuration"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/Configuration.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Configuration</span></a></summary>
|
|
475
|
+
<div class="tsd-accordion-details">
|
|
476
|
+
<ul class="tsd-nested-navigation">
|
|
477
|
+
<li><a href="Configuration.AutocompleteComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Autocomplete<wbr/>Component<wbr/>Config</span></a></li>
|
|
478
|
+
<li><a href="Configuration.BaseComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Component<wbr/>Config</span></a></li>
|
|
479
|
+
<li><a href="Configuration.Breakpoints.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Breakpoints</span></a></li>
|
|
480
|
+
<li><a href="Configuration.CheckboxListFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Checkbox<wbr/>List<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
481
|
+
<li><a href="Configuration.ColorFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Color<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
482
|
+
<li><a href="Configuration.ContentZoneComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Content<wbr/>Zone<wbr/>Component<wbr/>Config</span></a></li>
|
|
483
|
+
<li><a href="Configuration.ConversationalSearchComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Conversational<wbr/>Search<wbr/>Component<wbr/>Config</span></a></li>
|
|
484
|
+
<li><a href="Configuration.CustomContentComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Custom<wbr/>Content<wbr/>Component<wbr/>Config</span></a></li>
|
|
485
|
+
<li><a href="Configuration.DatePickerComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Date<wbr/>Picker<wbr/>Component<wbr/>Config</span></a></li>
|
|
486
|
+
<li><a href="Configuration.DateRangeFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Date<wbr/>Range<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
487
|
+
<li><a href="Configuration.FacetWrapperComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Facet<wbr/>Wrapper<wbr/>Component<wbr/>Config</span></a></li>
|
|
488
|
+
<li><a href="Configuration.FacetsListComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Facets<wbr/>List<wbr/>Component<wbr/>Config</span></a></li>
|
|
489
|
+
<li><a href="Configuration.FeaturedItemsContentComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Featured<wbr/>Items<wbr/>Content<wbr/>Component<wbr/>Config</span></a></li>
|
|
490
|
+
<li><a href="Configuration.FeaturedItemsContentItemComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Featured<wbr/>Items<wbr/>Content<wbr/>Item<wbr/>Component<wbr/>Config</span></a></li>
|
|
491
|
+
<li><a href="Configuration.FieldMappings.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Field<wbr/>Mappings</span></a></li>
|
|
492
|
+
<li><a href="Configuration.HawkSearchComponents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Hawk<wbr/>Search<wbr/>Components</span></a></li>
|
|
493
|
+
<li><a href="Configuration.HawkSearchConfig.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Hawk<wbr/>Search<wbr/>Config</span></a></li>
|
|
494
|
+
<li><a href="Configuration.HawkSearchGlobal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Hawk<wbr/>Search<wbr/>Global</span></a></li>
|
|
495
|
+
<li><a href="Configuration.HawkSearchState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Hawk<wbr/>Search<wbr/>State</span></a></li>
|
|
496
|
+
<li><a href="Configuration.IconComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Icon<wbr/>Component<wbr/>Config</span></a></li>
|
|
497
|
+
<li><a href="Configuration.ImageContentComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Image<wbr/>Content<wbr/>Component<wbr/>Config</span></a></li>
|
|
498
|
+
<li><a href="Configuration.LandingPageComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Landing<wbr/>Page<wbr/>Component<wbr/>Config</span></a></li>
|
|
499
|
+
<li><a href="Configuration.LinkListFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Link<wbr/>List<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
500
|
+
<li><a href="Configuration.ModifiedQueryComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modified<wbr/>Query<wbr/>Component<wbr/>Config</span></a></li>
|
|
501
|
+
<li><a href="Configuration.NumericRangeFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Numeric<wbr/>Range<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
502
|
+
<li><a href="Configuration.PageSizeComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Page<wbr/>Size<wbr/>Component<wbr/>Config</span></a></li>
|
|
503
|
+
<li><a href="Configuration.PaginationComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pagination<wbr/>Component<wbr/>Config</span></a></li>
|
|
504
|
+
<li><a href="Configuration.PopularQueriesContentComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Popular<wbr/>Queries<wbr/>Content<wbr/>Component<wbr/>Config</span></a></li>
|
|
505
|
+
<li><a href="Configuration.QuerySuggestionsComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Query<wbr/>Suggestions<wbr/>Component<wbr/>Config</span></a></li>
|
|
506
|
+
<li><a href="Configuration.RangeSliderComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Range<wbr/>Slider<wbr/>Component<wbr/>Config</span></a></li>
|
|
507
|
+
<li><a href="Configuration.RangeSliderFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Range<wbr/>Slider<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
508
|
+
<li><a href="Configuration.RatingComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rating<wbr/>Component<wbr/>Config</span></a></li>
|
|
509
|
+
<li><a href="Configuration.RecentSearchesFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Recent<wbr/>Searches<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
510
|
+
<li><a href="Configuration.RecommendationsComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Recommendations<wbr/>Component<wbr/>Config</span></a></li>
|
|
511
|
+
<li><a href="Configuration.RecommendationsItemComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Recommendations<wbr/>Item<wbr/>Component<wbr/>Config</span></a></li>
|
|
512
|
+
<li><a href="Configuration.RelatedSearchesFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Related<wbr/>Searches<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
513
|
+
<li><a href="Configuration.SearchFieldComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Field<wbr/>Component<wbr/>Config</span></a></li>
|
|
514
|
+
<li><a href="Configuration.SearchResultsComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Results<wbr/>Component<wbr/>Config</span></a></li>
|
|
515
|
+
<li><a href="Configuration.SearchResultsItemComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Results<wbr/>Item<wbr/>Component<wbr/>Config</span></a></li>
|
|
516
|
+
<li><a href="Configuration.SearchResultsListComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Results<wbr/>List<wbr/>Component<wbr/>Config</span></a></li>
|
|
517
|
+
<li><a href="Configuration.SearchWithinFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Search<wbr/>Within<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
518
|
+
<li><a href="Configuration.SelectedFacetsComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Selected<wbr/>Facets<wbr/>Component<wbr/>Config</span></a></li>
|
|
519
|
+
<li><a href="Configuration.SizeFacetComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Size<wbr/>Facet<wbr/>Component<wbr/>Config</span></a></li>
|
|
520
|
+
<li><a href="Configuration.SmartResponseComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Smart<wbr/>Response<wbr/>Component<wbr/>Config</span></a></li>
|
|
521
|
+
<li><a href="Configuration.SmartSearchFieldComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Smart<wbr/>Search<wbr/>Field<wbr/>Component<wbr/>Config</span></a></li>
|
|
522
|
+
<li><a href="Configuration.SortingComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Sorting<wbr/>Component<wbr/>Config</span></a></li>
|
|
523
|
+
<li><a href="Configuration.TabsComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tabs<wbr/>Component<wbr/>Config</span></a></li>
|
|
524
|
+
<li><a href="Configuration.TooltipComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tooltip<wbr/>Component<wbr/>Config</span></a></li>
|
|
525
|
+
<li><a href="Configuration.VariantFieldMappings.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Variant<wbr/>Field<wbr/>Mappings</span></a></li>
|
|
526
|
+
<li><a href="Configuration.VariantSelectorComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Variant<wbr/>Selector<wbr/>Component<wbr/>Config</span></a></li>
|
|
527
|
+
<li><a href="Configuration.VisualSearchFieldComponentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Visual<wbr/>Search<wbr/>Field<wbr/>Component<wbr/>Config</span></a></li>
|
|
528
|
+
<li><a href="../types/Configuration.DisplayType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Display<wbr/>Type</span></a></li></ul></div></details></li>
|
|
529
|
+
<li><a href="../modules/Helpers.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Helpers</span></a></li>
|
|
530
|
+
<li><a href="../modules/Models.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Models</span></a></li>
|
|
531
|
+
<li><a href="../modules/Services.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Services</span></a></li></ul></nav></div></div></div>
|
|
532
|
+
<div class="overlay"></div></body></html>
|