@bridgeline-digital/hawksearch-handlebars-ui 6.2.1 → 6.2.3
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 +19 -2
- package/dist/hawksearch-handlebars-ui.cjs +2 -2
- package/dist/hawksearch-handlebars-ui.js +18 -2
- package/dist/hawksearch-handlebars-ui.min.js +51 -51
- package/dist/hawksearch-handlebars-ui.umd.cjs +2 -2
- package/dist/index.d.ts +1 -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,494 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Components | @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="Components.html">Components</a></li></ul>
|
|
17
|
+
<h1>Module Components</h1></div>
|
|
18
|
+
<section class="tsd-panel tsd-comment">
|
|
19
|
+
<div class="tsd-comment tsd-typography"><a id="md:overriding-component-templates" class="tsd-anchor"></a><h2><a href="#md:overriding-component-templates">Overriding Component Templates</a></h2><p>This library was designed to be flexible and allow total customization of the markup used by all components.</p>
|
|
20
|
+
<p>There are two ways to replace the Handlebars template used by a component:</p>
|
|
21
|
+
<ul>
|
|
22
|
+
<li>Pass a template HTML string containing a Handlebars template.</li>
|
|
23
|
+
<li>Pass the ID of a template element containing a Handlebars template.</li>
|
|
24
|
+
</ul>
|
|
25
|
+
<p><em>Note: To avoid conflicts with BigCommerce and other systems that Handlebars for server-side rendering, this library also supports an alternate <code>[[value]]</code> syntax to work the same as the default Handlerbars <code>{{value}}</code> syntax.</em></p>
|
|
26
|
+
<a id="md:passing-an-html-string" class="tsd-anchor"></a><h3><a href="#md:passing-an-html-string">Passing an HTML string</a></h3><p>In your HTML file, define the template content directly in the configuration options:</p>
|
|
27
|
+
<pre><code class="language-html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"utf-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">HawkSearch Handlebars UI</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">type</span><span class="hl-5">=</span><span class="hl-4">"module"</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"//cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui/dist/hawksearch-handlebars-ui.min.js"</span><span class="hl-0">></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">type</span><span class="hl-5">=</span><span class="hl-4">"text/javascript"</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-6">addEventListener</span><span class="hl-5">(</span><span class="hl-7">'hawksearch:loaded'</span><span class="hl-5">, () </span><span class="hl-8">=></span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-9">HawkSearch</span><span class="hl-5">.</span><span class="hl-6">init</span><span class="hl-5">({</span><br/><span class="hl-5"> </span><span class="hl-9">clientId:</span><span class="hl-5"> </span><span class="hl-7">"YOUR_CLIENTID_HERE"</span><span class="hl-5">,</span><br/><span class="hl-5"> </span><span class="hl-9">components:</span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-9">pageSize:</span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-9">template:</span><span class="hl-5"> </span><span class="hl-7">`</span><br/><span class="hl-7"> <div class='page-size'></span><br/><span class="hl-7"> <select hawksearch-page-size></span><br/><span class="hl-7"> {{#each options}}</span><br/><span class="hl-7"> <option value='{{pageSize}}' {{attribute 'selected' selected}}>{{title}}</option></span><br/><span class="hl-7"> {{/each}}</span><br/><span class="hl-7"> </select></span><br/><span class="hl-7"> </div>`</span><br/><span class="hl-5"> }</span><br/><span class="hl-5"> }</span><br/><span class="hl-5"> });</span><br/><span class="hl-5"> });</span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">h1</span><span class="hl-0">></span><span class="hl-2">HawkSearch Handlebars UI</span><span class="hl-0"></</span><span class="hl-1">h1</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">hawksearch-search</span><span class="hl-0">></</span><span class="hl-1">hawksearch-search</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">hawksearch-results</span><span class="hl-0">></</span><span class="hl-1">hawksearch-results</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-0"></</span><span class="hl-1">html</span><span class="hl-0">></span>
|
|
28
|
+
</code><button>Copy</button></pre>
|
|
29
|
+
<a id="md:creating-a-script-or-template-element" class="tsd-anchor"></a><h3><a href="#md:creating-a-script-or-template-element">Creating a script or template element</a></h3><p>In your HTML file, add the custom markup to either a <code>script</code> element with <code>type</code> attribute set to <code>text/x-handlebars-template</code> or a <code>template</code> element and pass the ID in the configuration options:</p>
|
|
30
|
+
<pre><code class="language-html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"utf-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">HawkSearch Handlebars UI</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">type</span><span class="hl-5">=</span><span class="hl-4">"module"</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"//cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui/dist/hawksearch-handlebars-ui.min.js"</span><span class="hl-0">></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">type</span><span class="hl-5">=</span><span class="hl-4">"text/javascript"</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-6">addEventListener</span><span class="hl-5">(</span><span class="hl-7">'hawksearch:loaded'</span><span class="hl-5">, () </span><span class="hl-8">=></span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-9">HawkSearch</span><span class="hl-5">.</span><span class="hl-6">init</span><span class="hl-5">({</span><br/><span class="hl-5"> </span><span class="hl-9">clientId:</span><span class="hl-5"> </span><span class="hl-7">"f51060e1c38446f0bacdf283390c37e8"</span><span class="hl-5">,</span><br/><span class="hl-5"> </span><span class="hl-9">components:</span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-9">pageSize:</span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-9">template:</span><span class="hl-5"> </span><span class="hl-7">'page-size-template'</span><br/><span class="hl-5"> }</span><br/><span class="hl-5"> }</span><br/><span class="hl-5"> });</span><br/><span class="hl-5"> });</span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">h1</span><span class="hl-0">></span><span class="hl-2">HawkSearch Handlebars UI</span><span class="hl-0"></</span><span class="hl-1">h1</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">hawksearch-search</span><span class="hl-0">></</span><span class="hl-1">hawksearch-search</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">hawksearch-results</span><span class="hl-0">></</span><span class="hl-1">hawksearch-results</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">id</span><span class="hl-5">=</span><span class="hl-4">"page-size-template"</span><span class="hl-5"> </span><span class="hl-3">type</span><span class="hl-5">=</span><span class="hl-4">"text/x-handlebars-template"</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-0"><</span><span class="hl-1">div</span><span class="hl-5"> </span><span class="hl-3">class</span><span class="hl-5">=</span><span class="hl-4">'page-size'</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-0"><</span><span class="hl-1">select</span><span class="hl-5"> </span><span class="hl-3">hawksearch-page-size</span><span class="hl-0">></span><br/><span class="hl-5"> {{#each options}}</span><br/><span class="hl-5"> </span><span class="hl-0"><</span><span class="hl-1">option</span><span class="hl-5"> </span><span class="hl-3">value</span><span class="hl-5">=</span><span class="hl-4">'{{pageSize}}'</span><span class="hl-5"> </span><span class="hl-3">{{attribute</span><span class="hl-5"> </span><span class="hl-12">'selected'</span><span class="hl-5"> </span><span class="hl-3">selected}}</span><span class="hl-0">></span><span class="hl-5">{{title}}</span><span class="hl-0"></</span><span class="hl-1">option</span><span class="hl-0">></span><br/><span class="hl-5"> {{/each}}</span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">select</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">div</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-0"></</span><span class="hl-1">html</span><span class="hl-0">></span>
|
|
31
|
+
</code><button>Copy</button></pre>
|
|
32
|
+
<ul>
|
|
33
|
+
<li><em>Note: <code>script</code> elements are preferred over <code>template</code> elements as they prevent some browser parsing behavior which can conflict with Handlebars directives in some edge cases.</em></li>
|
|
34
|
+
</ul>
|
|
35
|
+
<p><em>Note: This approach tends to be easier to manage than the previous option as it is more compatible with popular HTML editors and templates can potentially be loaded from separate files using Server-side Includes (SSI).</em></p>
|
|
36
|
+
<a id="md:customizing-css" class="tsd-anchor"></a><h2><a href="#md:customizing-css">Customizing CSS</a></h2><p>By default, a neutral interface is rendered to get your search instance up and running quickly. However, this library was designed to be customizable and allow developers to use both custom markup and custom CSS.</p>
|
|
37
|
+
<p>For developers who only wish to tweak the default UI rather than create something from scratch, there are some variables and utility methods defined in the default CSS that are available for use.</p>
|
|
38
|
+
<a id="md:variables" class="tsd-anchor"></a><h3><a href="#md:variables">Variables</a></h3><p>Although all components in this library utilize the Shadow DOM, CSS variables are able to cross this boundary in a way that normal CSS rules are not. The following variables can be customized in the host DOM to easily customize some of the default styles:</p>
|
|
39
|
+
<table>
|
|
40
|
+
<thead>
|
|
41
|
+
<tr>
|
|
42
|
+
<th align="left">Variable</th>
|
|
43
|
+
<th align="left">Default Value</th>
|
|
44
|
+
</tr>
|
|
45
|
+
</thead>
|
|
46
|
+
<tbody><tr>
|
|
47
|
+
<td align="left">--hawksearch-container-background--alternate</td>
|
|
48
|
+
<td align="left"><code>var(--color-secondary-light)</code></td>
|
|
49
|
+
</tr>
|
|
50
|
+
<tr>
|
|
51
|
+
<td align="left">--hawksearch-container-border</td>
|
|
52
|
+
<td align="left"><code>solid 1px var(--color-secondary)</code></td>
|
|
53
|
+
</tr>
|
|
54
|
+
<tr>
|
|
55
|
+
<td align="left">--hawksearch-default-line-height</td>
|
|
56
|
+
<td align="left"><code>1.25</code></td>
|
|
57
|
+
</tr>
|
|
58
|
+
<tr>
|
|
59
|
+
<td align="left">--hawksearch-default-font-color</td>
|
|
60
|
+
<td align="left"><code>#333333</code></td>
|
|
61
|
+
</tr>
|
|
62
|
+
<tr>
|
|
63
|
+
<td align="left">--hawksearch-default-font-color--inverse</td>
|
|
64
|
+
<td align="left"><code>#ffffff</code></td>
|
|
65
|
+
</tr>
|
|
66
|
+
<tr>
|
|
67
|
+
<td align="left">--hawksearch-default-font-family</td>
|
|
68
|
+
<td align="left"><code>Arial, sans-serif</code></td>
|
|
69
|
+
</tr>
|
|
70
|
+
<tr>
|
|
71
|
+
<td align="left">--hawksearch-default-font-size</td>
|
|
72
|
+
<td align="left"><code>16px</code></td>
|
|
73
|
+
</tr>
|
|
74
|
+
<tr>
|
|
75
|
+
<td align="left">--hawksearch-button-background</td>
|
|
76
|
+
<td align="left"><code>var(--color-accent)</code></td>
|
|
77
|
+
</tr>
|
|
78
|
+
<tr>
|
|
79
|
+
<td align="left">--hawksearch-button-border-radius</td>
|
|
80
|
+
<td align="left"><code>5px</code></td>
|
|
81
|
+
</tr>
|
|
82
|
+
<tr>
|
|
83
|
+
<td align="left">--hawksearch-button-font-color</td>
|
|
84
|
+
<td align="left"><code>#ffffff</code></td>
|
|
85
|
+
</tr>
|
|
86
|
+
<tr>
|
|
87
|
+
<td align="left">--hawksearch-form-element-background</td>
|
|
88
|
+
<td align="left"><code>var(--color-background)</code></td>
|
|
89
|
+
</tr>
|
|
90
|
+
<tr>
|
|
91
|
+
<td align="left">--hawksearch-form-element-border</td>
|
|
92
|
+
<td align="left"><code>solid 1px var(--color-secondary)</code></td>
|
|
93
|
+
</tr>
|
|
94
|
+
<tr>
|
|
95
|
+
<td align="left">--hawksearch-form-element-border--focus</td>
|
|
96
|
+
<td align="left"><code>solid 1px var(--color-accent)</code></td>
|
|
97
|
+
</tr>
|
|
98
|
+
<tr>
|
|
99
|
+
<td align="left">--hawksearch-form-element-border-radius</td>
|
|
100
|
+
<td align="left"><code>0</code></td>
|
|
101
|
+
</tr>
|
|
102
|
+
<tr>
|
|
103
|
+
<td align="left">--hawksearch-form-element-placeholder-color</td>
|
|
104
|
+
<td align="left"><code>var(--color-secondary-dark)</code></td>
|
|
105
|
+
</tr>
|
|
106
|
+
<tr>
|
|
107
|
+
<td align="left">--hawksearch-margin</td>
|
|
108
|
+
<td align="left"><code>32px</code></td>
|
|
109
|
+
</tr>
|
|
110
|
+
<tr>
|
|
111
|
+
<td align="left">--hawksearch-margin-sm</td>
|
|
112
|
+
<td align="left"><code>calc(var(--margin) / 2)</code></td>
|
|
113
|
+
</tr>
|
|
114
|
+
<tr>
|
|
115
|
+
<td align="left">--hawksearch-padding</td>
|
|
116
|
+
<td align="left"><code>24px</code></td>
|
|
117
|
+
</tr>
|
|
118
|
+
<tr>
|
|
119
|
+
<td align="left">--hawksearch-padding-xs</td>
|
|
120
|
+
<td align="left"><code>calc(var(--padding) / 4)</code></td>
|
|
121
|
+
</tr>
|
|
122
|
+
<tr>
|
|
123
|
+
<td align="left">--hawksearch-padding-sm</td>
|
|
124
|
+
<td align="left"><code>calc(var(--padding) / 2)</code></td>
|
|
125
|
+
</tr>
|
|
126
|
+
<tr>
|
|
127
|
+
<td align="left">--hawksearch-secondary-font-color</td>
|
|
128
|
+
<td align="left"><code>var(--color-secondary-dark)</code></td>
|
|
129
|
+
</tr>
|
|
130
|
+
</tbody></table>
|
|
131
|
+
<p><em>Note: Internally, all variables omit the hawksearch- prefix. This prefix is used only to override the default values.</em></p>
|
|
132
|
+
<a id="md:breakpoints" class="tsd-anchor"></a><h3><a href="#md:breakpoints">Breakpoints</a></h3><p>This library uses responsive design with the following breakpoints defined:</p>
|
|
133
|
+
<table>
|
|
134
|
+
<thead>
|
|
135
|
+
<tr>
|
|
136
|
+
<th align="left">Name</th>
|
|
137
|
+
<th align="left">Suffix</th>
|
|
138
|
+
<th align="left">Minimum Width</th>
|
|
139
|
+
</tr>
|
|
140
|
+
</thead>
|
|
141
|
+
<tbody><tr>
|
|
142
|
+
<td align="left"></td>
|
|
143
|
+
<td align="left"></td>
|
|
144
|
+
<td align="left"><code>0px</code></td>
|
|
145
|
+
</tr>
|
|
146
|
+
<tr>
|
|
147
|
+
<td align="left">small</td>
|
|
148
|
+
<td align="left"><code>-sm</code></td>
|
|
149
|
+
<td align="left"><code>740px</code></td>
|
|
150
|
+
</tr>
|
|
151
|
+
<tr>
|
|
152
|
+
<td align="left">medium</td>
|
|
153
|
+
<td align="left"><code>-md</code></td>
|
|
154
|
+
<td align="left"><code>990px</code></td>
|
|
155
|
+
</tr>
|
|
156
|
+
<tr>
|
|
157
|
+
<td align="left">large</td>
|
|
158
|
+
<td align="left"><code>-lg</code></td>
|
|
159
|
+
<td align="left"><code>1260px</code></td>
|
|
160
|
+
</tr>
|
|
161
|
+
<tr>
|
|
162
|
+
<td align="left">extra-large</td>
|
|
163
|
+
<td align="left"><code>-xl</code></td>
|
|
164
|
+
<td align="left"><code>1800px</code></td>
|
|
165
|
+
</tr>
|
|
166
|
+
</tbody></table>
|
|
167
|
+
<a id="md:grid-system" class="tsd-anchor"></a><h3><a href="#md:grid-system">Grid System</a></h3><p>This library uses a 12-column, responsive grid system. To use this system, all columns must have a <code>column</code> class and be the direct children of an element with a <code>row</code> class. The number of columns each column elements spans can be controlled with <code>column--XX</code> classes.</p>
|
|
168
|
+
<p>For example, the following will render two equal columns that are stacked until the browser window reaches the <code>Medium</code> breakpoint:</p>
|
|
169
|
+
<pre><code class="language-html"><span class="hl-0"><</span><span class="hl-1">div</span><span class="hl-2"> </span><span class="hl-3">class</span><span class="hl-2">=</span><span class="hl-4">"row"</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">div</span><span class="hl-2"> </span><span class="hl-3">class</span><span class="hl-2">=</span><span class="hl-4">"column column--12 column-md--6"</span><span class="hl-0">></span><span class="hl-2">Column 1</span><span class="hl-0"></</span><span class="hl-1">div</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">div</span><span class="hl-2"> </span><span class="hl-3">class</span><span class="hl-2">=</span><span class="hl-4">"column column--12 column-md--6"</span><span class="hl-0">></span><span class="hl-2">Column 2</span><span class="hl-0"></</span><span class="hl-1">div</span><span class="hl-0">></span><br/><span class="hl-0"></</span><span class="hl-1">div</span><span class="hl-0">></span>
|
|
170
|
+
</code><button>Copy</button></pre>
|
|
171
|
+
<a id="md:row-modifiers" class="tsd-anchor"></a><h4><a href="#md:row-modifiers">Row Modifiers</a></h4><p>The following CSS classes can be added to modify the row display:</p>
|
|
172
|
+
<table>
|
|
173
|
+
<thead>
|
|
174
|
+
<tr>
|
|
175
|
+
<th align="left">CSS Class</th>
|
|
176
|
+
<th align="left">Description</th>
|
|
177
|
+
</tr>
|
|
178
|
+
</thead>
|
|
179
|
+
<tbody><tr>
|
|
180
|
+
<td align="left"><code>row--reverse</code></td>
|
|
181
|
+
<td align="left">This will cause all columns to be rendered in the reverse order that they are defined</td>
|
|
182
|
+
</tr>
|
|
183
|
+
<tr>
|
|
184
|
+
<td align="left"><code>row--tight</code></td>
|
|
185
|
+
<td align="left">This will reduce the space between columns to use <code>var(--padding-xs)</code></td>
|
|
186
|
+
</tr>
|
|
187
|
+
</tbody></table>
|
|
188
|
+
<a id="md:column-modifiers" class="tsd-anchor"></a><h4><a href="#md:column-modifiers">Column Modifiers</a></h4><p>The following CSS classes can be added to modify the column display:</p>
|
|
189
|
+
<table>
|
|
190
|
+
<thead>
|
|
191
|
+
<tr>
|
|
192
|
+
<th align="left">CSS Class</th>
|
|
193
|
+
<th align="left">Description</th>
|
|
194
|
+
</tr>
|
|
195
|
+
</thead>
|
|
196
|
+
<tbody><tr>
|
|
197
|
+
<td align="left"><code>column--pull-right</code></td>
|
|
198
|
+
<td align="left">This will force the column to pull to be aligned to the end of the row</td>
|
|
199
|
+
</tr>
|
|
200
|
+
</tbody></table>
|
|
201
|
+
<a id="md:utility-classes" class="tsd-anchor"></a><h3><a href="#md:utility-classes">Utility Classes</a></h3><p>There are several basic utility classes available to quickly customize the display of elements.</p>
|
|
202
|
+
<p><em>Note: All utility classes support the suffixes defined in Breakpoints. For example, <code>display-block</code> and <code>display-sm-none</code> are both valid.</em></p>
|
|
203
|
+
<ul>
|
|
204
|
+
<li><a id="md:display" class="tsd-anchor"></a><h4><a href="#md:display">Display</a></h4></li>
|
|
205
|
+
</ul>
|
|
206
|
+
<table>
|
|
207
|
+
<thead>
|
|
208
|
+
<tr>
|
|
209
|
+
<th align="left">CSS Class</th>
|
|
210
|
+
<th align="left">Description</th>
|
|
211
|
+
</tr>
|
|
212
|
+
</thead>
|
|
213
|
+
<tbody><tr>
|
|
214
|
+
<td align="left">display-block</td>
|
|
215
|
+
<td align="left">This will display an element</td>
|
|
216
|
+
</tr>
|
|
217
|
+
<tr>
|
|
218
|
+
<td align="left">display-none</td>
|
|
219
|
+
<td align="left">This will hide an element</td>
|
|
220
|
+
</tr>
|
|
221
|
+
</tbody></table>
|
|
222
|
+
<a id="md:flex-vertical" class="tsd-anchor"></a><h4><a href="#md:flex-vertical">Flex Vertical</a></h4><table>
|
|
223
|
+
<thead>
|
|
224
|
+
<tr>
|
|
225
|
+
<th align="left">CSS Class</th>
|
|
226
|
+
<th align="left">Description</th>
|
|
227
|
+
</tr>
|
|
228
|
+
</thead>
|
|
229
|
+
<tbody><tr>
|
|
230
|
+
<td align="left">flex-vertical-center</td>
|
|
231
|
+
<td align="left">This will vertically center the children of an element</td>
|
|
232
|
+
</tr>
|
|
233
|
+
</tbody></table>
|
|
234
|
+
<a id="md:flex-gap" class="tsd-anchor"></a><h4><a href="#md:flex-gap">Flex Gap</a></h4><table>
|
|
235
|
+
<thead>
|
|
236
|
+
<tr>
|
|
237
|
+
<th align="left">CSS Class</th>
|
|
238
|
+
<th align="left">Description</th>
|
|
239
|
+
</tr>
|
|
240
|
+
</thead>
|
|
241
|
+
<tbody><tr>
|
|
242
|
+
<td align="left">flex-gap</td>
|
|
243
|
+
<td align="left">This will add equal <code>var(--padding)</code> spacing between each child element and allow wrapping onto the next row when necessary</td>
|
|
244
|
+
</tr>
|
|
245
|
+
<tr>
|
|
246
|
+
<td align="left">flex-gap--none</td>
|
|
247
|
+
<td align="left">This modifier class eliminates the spacing between each child element</td>
|
|
248
|
+
</tr>
|
|
249
|
+
<tr>
|
|
250
|
+
<td align="left">flex-gap--sm</td>
|
|
251
|
+
<td align="left">This modifier class reduces the spacing between each element to <code>var(--padding-sm)</code></td>
|
|
252
|
+
</tr>
|
|
253
|
+
<tr>
|
|
254
|
+
<td align="left">flex-gap--xs</td>
|
|
255
|
+
<td align="left">This modifier class reduces the spacing between each element to <code>var(--padding-xs)</code></td>
|
|
256
|
+
</tr>
|
|
257
|
+
</tbody></table>
|
|
258
|
+
<a id="md:margin" class="tsd-anchor"></a><h4><a href="#md:margin">Margin</a></h4><table>
|
|
259
|
+
<thead>
|
|
260
|
+
<tr>
|
|
261
|
+
<th align="left">CSS Class</th>
|
|
262
|
+
<th align="left">Description</th>
|
|
263
|
+
</tr>
|
|
264
|
+
</thead>
|
|
265
|
+
<tbody><tr>
|
|
266
|
+
<td align="left">margin</td>
|
|
267
|
+
<td align="left">This adds bottom margin of <code>var(--margin)</code></td>
|
|
268
|
+
</tr>
|
|
269
|
+
<tr>
|
|
270
|
+
<td align="left">margin-none</td>
|
|
271
|
+
<td align="left">This removes bottom margin</td>
|
|
272
|
+
</tr>
|
|
273
|
+
<tr>
|
|
274
|
+
<td align="left">margin-sm</td>
|
|
275
|
+
<td align="left">This adds bottom margin of <code>var(--margin-sm)</code></td>
|
|
276
|
+
</tr>
|
|
277
|
+
</tbody></table>
|
|
278
|
+
<a id="md:width" class="tsd-anchor"></a><h4><a href="#md:width">Width</a></h4><table>
|
|
279
|
+
<thead>
|
|
280
|
+
<tr>
|
|
281
|
+
<th align="left">CSS Class</th>
|
|
282
|
+
<th align="left">Description</th>
|
|
283
|
+
</tr>
|
|
284
|
+
</thead>
|
|
285
|
+
<tbody><tr>
|
|
286
|
+
<td align="left">width-auto</td>
|
|
287
|
+
<td align="left">This allows an elements content to determine its width</td>
|
|
288
|
+
</tr>
|
|
289
|
+
<tr>
|
|
290
|
+
<td align="left">width-full</td>
|
|
291
|
+
<td align="left">This forces an element’s width to match its parent element</td>
|
|
292
|
+
</tr>
|
|
293
|
+
</tbody></table>
|
|
294
|
+
<a id="md:text-align" class="tsd-anchor"></a><h4><a href="#md:text-align">Text Align</a></h4><table>
|
|
295
|
+
<thead>
|
|
296
|
+
<tr>
|
|
297
|
+
<th align="left">CSS Class</th>
|
|
298
|
+
<th align="left">Description</th>
|
|
299
|
+
</tr>
|
|
300
|
+
</thead>
|
|
301
|
+
<tbody><tr>
|
|
302
|
+
<td align="left">text-align-left</td>
|
|
303
|
+
<td align="left">This aligns descendant content to the left</td>
|
|
304
|
+
</tr>
|
|
305
|
+
<tr>
|
|
306
|
+
<td align="left">text-align-center</td>
|
|
307
|
+
<td align="left">This aligns descendant content to the center</td>
|
|
308
|
+
</tr>
|
|
309
|
+
<tr>
|
|
310
|
+
<td align="left">text-align-right</td>
|
|
311
|
+
<td align="left">This aligns descendant content to the right</td>
|
|
312
|
+
</tr>
|
|
313
|
+
</tbody></table>
|
|
314
|
+
</div>
|
|
315
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
316
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
317
|
+
<section class="tsd-panel tsd-index-panel">
|
|
318
|
+
<h3 class="tsd-index-heading uppercase">Index</h3>
|
|
319
|
+
<section class="tsd-index-section">
|
|
320
|
+
<h3 class="tsd-index-heading">Base</h3>
|
|
321
|
+
<div class="tsd-index-list"><a href="../classes/Components.BaseComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Base<wbr/>Component</span></a>
|
|
322
|
+
</div></section>
|
|
323
|
+
<section class="tsd-index-section">
|
|
324
|
+
<h3 class="tsd-index-heading">Content</h3>
|
|
325
|
+
<div class="tsd-index-list"><a href="../classes/Components.BaseContentComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Content<wbr/>Component</span></a>
|
|
326
|
+
<a href="../classes/Components.ContentZoneComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Content<wbr/>Zone<wbr/>Component</span></a>
|
|
327
|
+
<a href="../classes/Components.CustomContentComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Custom<wbr/>Content<wbr/>Component</span></a>
|
|
328
|
+
<a href="../classes/Components.FeaturedItemsContentComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Featured<wbr/>Items<wbr/>Content<wbr/>Component</span></a>
|
|
329
|
+
<a href="../classes/Components.FeaturedItemsContentItemComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Featured<wbr/>Items<wbr/>Content<wbr/>Item<wbr/>Component</span></a>
|
|
330
|
+
<a href="../classes/Components.ImageContentComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Image<wbr/>Content<wbr/>Component</span></a>
|
|
331
|
+
<a href="../classes/Components.PopularQueriesContentComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Popular<wbr/>Queries<wbr/>Content<wbr/>Component</span></a>
|
|
332
|
+
</div></section>
|
|
333
|
+
<section class="tsd-index-section">
|
|
334
|
+
<h3 class="tsd-index-heading">Facet Types</h3>
|
|
335
|
+
<div class="tsd-index-list"><a href="../classes/Components.BaseFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Facet<wbr/>Component</span></a>
|
|
336
|
+
<a href="../classes/Components.CheckboxListFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Checkbox<wbr/>List<wbr/>Facet<wbr/>Component</span></a>
|
|
337
|
+
<a href="../classes/Components.ColorFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Color<wbr/>Facet<wbr/>Component</span></a>
|
|
338
|
+
<a href="../classes/Components.DateRangeFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Date<wbr/>Range<wbr/>Facet<wbr/>Component</span></a>
|
|
339
|
+
<a href="../classes/Components.LinkListFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Link<wbr/>List<wbr/>Facet<wbr/>Component</span></a>
|
|
340
|
+
<a href="../classes/Components.NumericRangeFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Numeric<wbr/>Range<wbr/>Facet<wbr/>Component</span></a>
|
|
341
|
+
<a href="../classes/Components.RangeSliderFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Range<wbr/>Slider<wbr/>Facet<wbr/>Component</span></a>
|
|
342
|
+
<a href="../classes/Components.RecentSearchesFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Recent<wbr/>Searches<wbr/>Facet<wbr/>Component</span></a>
|
|
343
|
+
<a href="../classes/Components.RelatedSearchesFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Related<wbr/>Searches<wbr/>Facet<wbr/>Component</span></a>
|
|
344
|
+
<a href="../classes/Components.SearchWithinFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Within<wbr/>Facet<wbr/>Component</span></a>
|
|
345
|
+
<a href="../classes/Components.SizeFacetComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Size<wbr/>Facet<wbr/>Component</span></a>
|
|
346
|
+
</div></section>
|
|
347
|
+
<section class="tsd-index-section">
|
|
348
|
+
<h3 class="tsd-index-heading">General</h3>
|
|
349
|
+
<div class="tsd-index-list"><a href="../classes/Components.DatePickerComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Date<wbr/>Picker<wbr/>Component</span></a>
|
|
350
|
+
<a href="../classes/Components.IconComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Icon<wbr/>Component</span></a>
|
|
351
|
+
<a href="../classes/Components.RangeSliderComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Range<wbr/>Slider<wbr/>Component</span></a>
|
|
352
|
+
<a href="../classes/Components.RatingComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rating<wbr/>Component</span></a>
|
|
353
|
+
<a href="../classes/Components.SmartResponseComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Smart<wbr/>Response<wbr/>Component</span></a>
|
|
354
|
+
<a href="../classes/Components.TooltipComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tooltip<wbr/>Component</span></a>
|
|
355
|
+
</div></section>
|
|
356
|
+
<section class="tsd-index-section">
|
|
357
|
+
<h3 class="tsd-index-heading">Landing Pages</h3>
|
|
358
|
+
<div class="tsd-index-list"><a href="../classes/Components.LandingPageComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Landing<wbr/>Page<wbr/>Component</span></a>
|
|
359
|
+
</div></section>
|
|
360
|
+
<section class="tsd-index-section">
|
|
361
|
+
<h3 class="tsd-index-heading">Recommendations</h3>
|
|
362
|
+
<div class="tsd-index-list"><a href="../classes/Components.RecommendationsComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Recommendations<wbr/>Component</span></a>
|
|
363
|
+
<a href="../classes/Components.RecommendationsItemComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Recommendations<wbr/>Item<wbr/>Component</span></a>
|
|
364
|
+
</div></section>
|
|
365
|
+
<section class="tsd-index-section">
|
|
366
|
+
<h3 class="tsd-index-heading">Search</h3>
|
|
367
|
+
<div class="tsd-index-list"><a href="../classes/Components.AutocompleteComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Autocomplete<wbr/>Component</span></a>
|
|
368
|
+
<a href="../classes/Components.ConceptSearchFieldComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Concept<wbr/>Search<wbr/>Field<wbr/>Component</span></a>
|
|
369
|
+
<a href="../classes/Components.ConversationalSearchComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Conversational<wbr/>Search<wbr/>Component</span></a>
|
|
370
|
+
<a href="../classes/Components.FacetWrapperComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Facet<wbr/>Wrapper<wbr/>Component</span></a>
|
|
371
|
+
<a href="../classes/Components.FacetsListComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Facets<wbr/>List<wbr/>Component</span></a>
|
|
372
|
+
<a href="../classes/Components.ImageSearchFieldComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Image<wbr/>Search<wbr/>Field<wbr/>Component</span></a>
|
|
373
|
+
<a href="../classes/Components.ModifiedQueryComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Modified<wbr/>Query<wbr/>Component</span></a>
|
|
374
|
+
<a href="../classes/Components.PageSizeComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Page<wbr/>Size<wbr/>Component</span></a>
|
|
375
|
+
<a href="../classes/Components.PaginationComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Pagination<wbr/>Component</span></a>
|
|
376
|
+
<a href="../classes/Components.QuerySuggestionsComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Query<wbr/>Suggestions<wbr/>Component</span></a>
|
|
377
|
+
<a href="../classes/Components.SearchFieldComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Field<wbr/>Component</span></a>
|
|
378
|
+
<a href="../classes/Components.SearchResultsComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Results<wbr/>Component</span></a>
|
|
379
|
+
<a href="../classes/Components.SearchResultsItemComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Results<wbr/>Item<wbr/>Component</span></a>
|
|
380
|
+
<a href="../classes/Components.SearchResultsListComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Results<wbr/>List<wbr/>Component</span></a>
|
|
381
|
+
<a href="../classes/Components.SelectedFacetsComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Selected<wbr/>Facets<wbr/>Component</span></a>
|
|
382
|
+
<a href="../classes/Components.SortingComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Sorting<wbr/>Component</span></a>
|
|
383
|
+
<a href="../classes/Components.TabsComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tabs<wbr/>Component</span></a>
|
|
384
|
+
<a href="../classes/Components.VisualSearchFieldComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Visual<wbr/>Search<wbr/>Field<wbr/>Component</span></a>
|
|
385
|
+
</div></section>
|
|
386
|
+
<section class="tsd-index-section">
|
|
387
|
+
<h3 class="tsd-index-heading">Variants</h3>
|
|
388
|
+
<div class="tsd-index-list"><a href="../classes/Components.VariantSelectorComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Variant<wbr/>Selector<wbr/>Component</span></a>
|
|
389
|
+
</div></section></section></section></div>
|
|
390
|
+
<div class="col-sidebar">
|
|
391
|
+
<div class="page-menu">
|
|
392
|
+
<div class="tsd-navigation settings">
|
|
393
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
394
|
+
<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>
|
|
395
|
+
<div class="tsd-accordion-details">
|
|
396
|
+
<div class="tsd-filter-visibility">
|
|
397
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
398
|
+
<ul id="tsd-filter-options">
|
|
399
|
+
<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>
|
|
400
|
+
<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>
|
|
401
|
+
<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>
|
|
402
|
+
<div class="tsd-theme-toggle">
|
|
403
|
+
<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>
|
|
404
|
+
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
405
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
406
|
+
<div class="tsd-accordion-details">
|
|
407
|
+
<ul>
|
|
408
|
+
<li>
|
|
409
|
+
<ul>
|
|
410
|
+
<li><a href="#md:overriding-component-templates"><span>Overriding <wbr/>Component <wbr/>Templates</span></a></li>
|
|
411
|
+
<li>
|
|
412
|
+
<ul>
|
|
413
|
+
<li><a href="#md:passing-an-html-string"><span>Passing an HTML string</span></a></li>
|
|
414
|
+
<li>
|
|
415
|
+
<ul>
|
|
416
|
+
<li><a href="#md:creating-a-script-or-template-element"><span>Creating a script or template element</span></a></li></ul></li>
|
|
417
|
+
<li><a href="#md:customizing-css"><span>Customizing CSS</span></a></li>
|
|
418
|
+
<li>
|
|
419
|
+
<ul>
|
|
420
|
+
<li><a href="#md:variables"><span>Variables</span></a></li>
|
|
421
|
+
<li><a href="#md:breakpoints"><span>Breakpoints</span></a></li>
|
|
422
|
+
<li><a href="#md:grid-system"><span>Grid <wbr/>System</span></a></li>
|
|
423
|
+
<li>
|
|
424
|
+
<ul>
|
|
425
|
+
<li><a href="#md:row-modifiers"><span>Row <wbr/>Modifiers</span></a></li>
|
|
426
|
+
<li><a href="#md:column-modifiers"><span>Column <wbr/>Modifiers</span></a></li></ul></li>
|
|
427
|
+
<li><a href="#md:utility-classes"><span>Utility <wbr/>Classes</span></a></li>
|
|
428
|
+
<li>
|
|
429
|
+
<ul>
|
|
430
|
+
<li><a href="#md:display"><span>Display</span></a></li>
|
|
431
|
+
<li><a href="#md:flex-vertical"><span>Flex <wbr/>Vertical</span></a></li>
|
|
432
|
+
<li><a href="#md:flex-gap"><span>Flex <wbr/>Gap</span></a></li>
|
|
433
|
+
<li><a href="#md:margin"><span>Margin</span></a></li>
|
|
434
|
+
<li><a href="#md:width"><span>Width</span></a></li>
|
|
435
|
+
<li><a href="#md:text-align"><span>Text <wbr/>Align</span></a></li></ul></li></ul></li></ul></li></ul></li></ul></div></details></div>
|
|
436
|
+
<div class="site-menu">
|
|
437
|
+
<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>
|
|
438
|
+
<ul class="tsd-small-nested-navigation">
|
|
439
|
+
<li>
|
|
440
|
+
<details class="tsd-index-accordion" open data-key="Components"><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="Components.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Components</span></a></summary>
|
|
441
|
+
<div class="tsd-accordion-details">
|
|
442
|
+
<ul class="tsd-nested-navigation">
|
|
443
|
+
<li><a href="../classes/Components.AutocompleteComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Autocomplete<wbr/>Component</span></a></li>
|
|
444
|
+
<li><a href="../classes/Components.BaseComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Component</span></a></li>
|
|
445
|
+
<li><a href="../classes/Components.BaseContentComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Content<wbr/>Component</span></a></li>
|
|
446
|
+
<li><a href="../classes/Components.BaseFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Facet<wbr/>Component</span></a></li>
|
|
447
|
+
<li><a href="../classes/Components.CheckboxListFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Checkbox<wbr/>List<wbr/>Facet<wbr/>Component</span></a></li>
|
|
448
|
+
<li><a href="../classes/Components.ColorFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Color<wbr/>Facet<wbr/>Component</span></a></li>
|
|
449
|
+
<li><a href="../classes/Components.ConceptSearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Concept<wbr/>Search<wbr/>Field<wbr/>Component</span></a></li>
|
|
450
|
+
<li><a href="../classes/Components.ContentZoneComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Content<wbr/>Zone<wbr/>Component</span></a></li>
|
|
451
|
+
<li><a href="../classes/Components.ConversationalSearchComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Conversational<wbr/>Search<wbr/>Component</span></a></li>
|
|
452
|
+
<li><a href="../classes/Components.CustomContentComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Custom<wbr/>Content<wbr/>Component</span></a></li>
|
|
453
|
+
<li><a href="../classes/Components.DatePickerComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Date<wbr/>Picker<wbr/>Component</span></a></li>
|
|
454
|
+
<li><a href="../classes/Components.DateRangeFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Date<wbr/>Range<wbr/>Facet<wbr/>Component</span></a></li>
|
|
455
|
+
<li><a href="../classes/Components.FacetWrapperComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Facet<wbr/>Wrapper<wbr/>Component</span></a></li>
|
|
456
|
+
<li><a href="../classes/Components.FacetsListComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Facets<wbr/>List<wbr/>Component</span></a></li>
|
|
457
|
+
<li><a href="../classes/Components.FeaturedItemsContentComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Featured<wbr/>Items<wbr/>Content<wbr/>Component</span></a></li>
|
|
458
|
+
<li><a href="../classes/Components.FeaturedItemsContentItemComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Featured<wbr/>Items<wbr/>Content<wbr/>Item<wbr/>Component</span></a></li>
|
|
459
|
+
<li><a href="../classes/Components.IconComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Icon<wbr/>Component</span></a></li>
|
|
460
|
+
<li><a href="../classes/Components.ImageContentComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Image<wbr/>Content<wbr/>Component</span></a></li>
|
|
461
|
+
<li><a href="../classes/Components.ImageSearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Image<wbr/>Search<wbr/>Field<wbr/>Component</span></a></li>
|
|
462
|
+
<li><a href="../classes/Components.LandingPageComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Landing<wbr/>Page<wbr/>Component</span></a></li>
|
|
463
|
+
<li><a href="../classes/Components.LinkListFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Link<wbr/>List<wbr/>Facet<wbr/>Component</span></a></li>
|
|
464
|
+
<li><a href="../classes/Components.ModifiedQueryComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Modified<wbr/>Query<wbr/>Component</span></a></li>
|
|
465
|
+
<li><a href="../classes/Components.NumericRangeFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Numeric<wbr/>Range<wbr/>Facet<wbr/>Component</span></a></li>
|
|
466
|
+
<li><a href="../classes/Components.PageSizeComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Page<wbr/>Size<wbr/>Component</span></a></li>
|
|
467
|
+
<li><a href="../classes/Components.PaginationComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Pagination<wbr/>Component</span></a></li>
|
|
468
|
+
<li><a href="../classes/Components.PopularQueriesContentComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Popular<wbr/>Queries<wbr/>Content<wbr/>Component</span></a></li>
|
|
469
|
+
<li><a href="../classes/Components.QuerySuggestionsComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Query<wbr/>Suggestions<wbr/>Component</span></a></li>
|
|
470
|
+
<li><a href="../classes/Components.RangeSliderComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Range<wbr/>Slider<wbr/>Component</span></a></li>
|
|
471
|
+
<li><a href="../classes/Components.RangeSliderFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Range<wbr/>Slider<wbr/>Facet<wbr/>Component</span></a></li>
|
|
472
|
+
<li><a href="../classes/Components.RatingComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rating<wbr/>Component</span></a></li>
|
|
473
|
+
<li><a href="../classes/Components.RecentSearchesFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Recent<wbr/>Searches<wbr/>Facet<wbr/>Component</span></a></li>
|
|
474
|
+
<li><a href="../classes/Components.RecommendationsComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Recommendations<wbr/>Component</span></a></li>
|
|
475
|
+
<li><a href="../classes/Components.RecommendationsItemComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Recommendations<wbr/>Item<wbr/>Component</span></a></li>
|
|
476
|
+
<li><a href="../classes/Components.RelatedSearchesFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Related<wbr/>Searches<wbr/>Facet<wbr/>Component</span></a></li>
|
|
477
|
+
<li><a href="../classes/Components.SearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Field<wbr/>Component</span></a></li>
|
|
478
|
+
<li><a href="../classes/Components.SearchResultsComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Results<wbr/>Component</span></a></li>
|
|
479
|
+
<li><a href="../classes/Components.SearchResultsItemComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Results<wbr/>Item<wbr/>Component</span></a></li>
|
|
480
|
+
<li><a href="../classes/Components.SearchResultsListComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Results<wbr/>List<wbr/>Component</span></a></li>
|
|
481
|
+
<li><a href="../classes/Components.SearchWithinFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Search<wbr/>Within<wbr/>Facet<wbr/>Component</span></a></li>
|
|
482
|
+
<li><a href="../classes/Components.SelectedFacetsComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Selected<wbr/>Facets<wbr/>Component</span></a></li>
|
|
483
|
+
<li><a href="../classes/Components.SizeFacetComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Size<wbr/>Facet<wbr/>Component</span></a></li>
|
|
484
|
+
<li><a href="../classes/Components.SmartResponseComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Smart<wbr/>Response<wbr/>Component</span></a></li>
|
|
485
|
+
<li><a href="../classes/Components.SortingComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Sorting<wbr/>Component</span></a></li>
|
|
486
|
+
<li><a href="../classes/Components.TabsComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tabs<wbr/>Component</span></a></li>
|
|
487
|
+
<li><a href="../classes/Components.TooltipComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tooltip<wbr/>Component</span></a></li>
|
|
488
|
+
<li><a href="../classes/Components.VariantSelectorComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Variant<wbr/>Selector<wbr/>Component</span></a></li>
|
|
489
|
+
<li><a href="../classes/Components.VisualSearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Visual<wbr/>Search<wbr/>Field<wbr/>Component</span></a></li></ul></div></details></li>
|
|
490
|
+
<li><a href="Configuration.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Configuration</span></a></li>
|
|
491
|
+
<li><a href="Helpers.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Helpers</span></a></li>
|
|
492
|
+
<li><a href="Models.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Models</span></a></li>
|
|
493
|
+
<li><a href="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>
|
|
494
|
+
<div class="overlay"></div></body></html>
|