@bridgeline-digital/hawksearch-handlebars-ui 6.2.3 → 6.2.4
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 +11 -1
- package/dist/hawksearch-handlebars-ui.cjs +2 -2
- package/dist/hawksearch-handlebars-ui.js +66 -31
- package/dist/hawksearch-handlebars-ui.min.js +53 -53
- package/dist/hawksearch-handlebars-ui.umd.cjs +2 -2
- package/dist/index.d.ts +17 -0
- package/docs/assets/highlight.css +15 -8
- package/docs/assets/search.js +1 -1
- package/docs/classes/Components.AutocompleteComponent.html +25 -3
- package/docs/classes/Components.BaseComponent.html +24 -2
- package/docs/classes/Components.BaseContentComponent.html +24 -2
- package/docs/classes/Components.BaseFacetComponent.html +24 -2
- package/docs/classes/Components.CheckboxListFacetComponent.html +25 -3
- package/docs/classes/Components.ColorFacetComponent.html +25 -3
- package/docs/classes/Components.ConceptSearchFieldComponent.html +24 -2
- package/docs/classes/Components.ContentZoneComponent.html +25 -3
- package/docs/classes/Components.ConversationalSearchComponent.html +25 -3
- package/docs/classes/Components.CustomContentComponent.html +24 -2
- package/docs/classes/Components.DatePickerComponent.html +25 -3
- package/docs/classes/Components.DateRangeFacetComponent.html +25 -3
- package/docs/classes/Components.FacetWrapperComponent.html +25 -3
- package/docs/classes/Components.FacetsListComponent.html +25 -3
- package/docs/classes/Components.FeaturedItemsContentComponent.html +25 -3
- package/docs/classes/Components.FeaturedItemsContentItemComponent.html +25 -3
- package/docs/classes/Components.IconComponent.html +25 -3
- package/docs/classes/Components.ImageContentComponent.html +24 -2
- package/docs/classes/Components.ImageSearchFieldComponent.html +24 -2
- package/docs/classes/Components.LandingPageComponent.html +25 -3
- package/docs/classes/Components.LinkListFacetComponent.html +24 -2
- package/docs/classes/Components.ModifiedQueryComponent.html +25 -3
- package/docs/classes/Components.NumericRangeFacetComponent.html +24 -2
- package/docs/classes/Components.PageSizeComponent.html +24 -2
- package/docs/classes/Components.PaginationComponent.html +25 -3
- package/docs/classes/Components.PopularQueriesContentComponent.html +24 -2
- package/docs/classes/Components.QuerySuggestionsComponent.html +25 -3
- package/docs/classes/Components.RangeSliderComponent.html +25 -3
- package/docs/classes/Components.RangeSliderFacetComponent.html +25 -3
- package/docs/classes/Components.RatingComponent.html +25 -3
- package/docs/classes/Components.RecentSearchesFacetComponent.html +24 -2
- package/docs/classes/Components.RecommendationsComponent.html +25 -3
- package/docs/classes/Components.RecommendationsItemComponent.html +25 -3
- package/docs/classes/Components.RelatedSearchesFacetComponent.html +24 -2
- package/docs/classes/Components.SearchFieldComponent.html +25 -3
- package/docs/classes/Components.SearchResultsComponent.html +25 -3
- package/docs/classes/Components.SearchResultsItemComponent.html +25 -3
- package/docs/classes/Components.SearchResultsListComponent.html +25 -3
- package/docs/classes/Components.SearchWithinFacetComponent.html +24 -2
- package/docs/classes/Components.SelectedFacetsComponent.html +25 -3
- package/docs/classes/Components.SizeFacetComponent.html +25 -3
- package/docs/classes/Components.SmartResponseComponent.html +25 -3
- package/docs/classes/Components.SortingComponent.html +24 -2
- package/docs/classes/Components.TabsComponent.html +24 -2
- package/docs/classes/Components.TooltipComponent.html +25 -3
- package/docs/classes/Components.UnifiedSearchFieldComponent.html +361 -0
- package/docs/classes/Components.VariantSelectorComponent.html +25 -3
- package/docs/classes/Components.VisualSearchFieldComponent.html +25 -3
- package/docs/enums/Models.AutocompleteItemType.html +1 -0
- package/docs/enums/Models.EventType.html +1 -0
- package/docs/enums/Models.PageType.html +1 -0
- package/docs/enums/Models.SearchType.html +1 -0
- package/docs/index.html +15 -3
- package/docs/interfaces/Configuration.HawkSearchComponents.html +5 -0
- package/docs/interfaces/Configuration.HawkSearchConfig.html +1 -1
- package/docs/interfaces/Configuration.SmartSearchFieldComponentConfig.html +2 -2
- package/docs/interfaces/Models.AutocompleteCategories.html +1 -0
- package/docs/interfaces/Models.AutocompleteCategory.html +1 -0
- package/docs/interfaces/Models.AutocompleteComponentModel.html +1 -0
- package/docs/interfaces/Models.AutocompleteContent.html +1 -0
- package/docs/interfaces/Models.AutocompleteContentResult.html +1 -0
- package/docs/interfaces/Models.AutocompleteProductResult.html +1 -0
- package/docs/interfaces/Models.AutocompleteProducts.html +1 -0
- package/docs/interfaces/Models.AutocompleteQueries.html +1 -0
- package/docs/interfaces/Models.AutocompleteQuery.html +1 -0
- package/docs/interfaces/Models.AutocompleteRequest.html +1 -0
- package/docs/interfaces/Models.AutocompleteResponse.html +1 -0
- package/docs/interfaces/Models.BaseComponentModel.html +1 -0
- package/docs/interfaces/Models.CalendarDay.html +1 -0
- package/docs/interfaces/Models.CheckboxListFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.CheckboxListFacetValue.html +1 -0
- package/docs/interfaces/Models.ColorFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.ColorFacetValue.html +1 -0
- package/docs/interfaces/Models.ContentConfiguration.html +1 -0
- package/docs/interfaces/Models.ContentType.html +1 -0
- package/docs/interfaces/Models.ContentZone.html +1 -0
- package/docs/interfaces/Models.ContentZoneComponentModel.html +1 -0
- package/docs/interfaces/Models.ContentZoneItem.html +1 -0
- package/docs/interfaces/Models.ContentZones.html +1 -0
- package/docs/interfaces/Models.ConversationalSearchComponentModel.html +1 -0
- package/docs/interfaces/Models.CustomContent.html +1 -0
- package/docs/interfaces/Models.CustomContentComponentModel.html +1 -0
- package/docs/interfaces/Models.CustomWidgetContent.html +1 -0
- package/docs/interfaces/Models.DateFacetRange.html +1 -0
- package/docs/interfaces/Models.DatePickerComponentModel.html +1 -0
- package/docs/interfaces/Models.DateRangeFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.Facet.html +1 -0
- package/docs/interfaces/Models.FacetScrolling.html +1 -0
- package/docs/interfaces/Models.FacetSearch.html +1 -0
- package/docs/interfaces/Models.FacetTruncation.html +1 -0
- package/docs/interfaces/Models.FacetValue.html +1 -0
- package/docs/interfaces/Models.FacetValueColor.html +1 -0
- package/docs/interfaces/Models.FacetWrapperComponentModel.html +1 -0
- package/docs/interfaces/Models.FacetsListComponentModel.html +1 -0
- package/docs/interfaces/Models.FeaturedItemsContent.html +1 -0
- package/docs/interfaces/Models.FeaturedItemsContentComponentModel.html +1 -0
- package/docs/interfaces/Models.FeaturedItemsContentItem.html +1 -0
- package/docs/interfaces/Models.FeaturedItemsContentItemComponentModel.html +1 -0
- package/docs/interfaces/Models.IconComponentModel.html +1 -0
- package/docs/interfaces/Models.ImageContent.html +1 -0
- package/docs/interfaces/Models.ImageContentComponentModel.html +1 -0
- package/docs/interfaces/Models.Item.html +1 -0
- package/docs/interfaces/Models.ItemVariant.html +1 -0
- package/docs/interfaces/Models.LandingPageComponentModel.html +1 -0
- package/docs/interfaces/Models.LinkListFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.LinkListFacetValue.html +1 -0
- package/docs/interfaces/Models.MessageItem.html +1 -0
- package/docs/interfaces/Models.MessageItemList.html +2 -1
- package/docs/interfaces/Models.ModifiedQueryComponentModel.html +1 -0
- package/docs/interfaces/Models.ModifiedQueryData.html +1 -0
- package/docs/interfaces/Models.NumericFacetRange.html +1 -0
- package/docs/interfaces/Models.NumericRangeFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.PageSizeComponentModel.html +1 -0
- package/docs/interfaces/Models.Pagination.html +1 -0
- package/docs/interfaces/Models.PaginationComponentModel.html +1 -0
- package/docs/interfaces/Models.PaginationOption.html +1 -0
- package/docs/interfaces/Models.PopularQueriesContent.html +1 -0
- package/docs/interfaces/Models.PopularQueriesContentComponentModel.html +1 -0
- package/docs/interfaces/Models.PopularQueriesContentItem.html +1 -0
- package/docs/interfaces/Models.QuerySuggestionsComponentModel.html +1 -0
- package/docs/interfaces/Models.QuerySuggestionsData.html +1 -0
- package/docs/interfaces/Models.RangeSliderComponentModel.html +1 -0
- package/docs/interfaces/Models.RangeSliderEventData.html +1 -0
- package/docs/interfaces/Models.RangeSliderFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.RatingComponentModel.html +1 -0
- package/docs/interfaces/Models.RecentSearchesFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.RecommendationsCarouselData.html +232 -0
- package/docs/interfaces/Models.RecommendationsComponentModel.html +7 -0
- package/docs/interfaces/Models.RecommendationsItem.html +1 -0
- package/docs/interfaces/Models.RecommendationsItemComponentModel.html +1 -0
- package/docs/interfaces/Models.RecommendationsRequest.html +1 -0
- package/docs/interfaces/Models.RecommendationsResponse.html +1 -0
- package/docs/interfaces/Models.RecommendationsWidget.html +6 -0
- package/docs/interfaces/Models.Redirect.html +1 -0
- package/docs/interfaces/Models.RelatedSearchesFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.SearchFieldComponentModel.html +1 -0
- package/docs/interfaces/Models.SearchRequest.html +1 -0
- package/docs/interfaces/Models.SearchResponse.html +1 -0
- package/docs/interfaces/Models.SearchResultsComponentModel.html +1 -0
- package/docs/interfaces/Models.SearchResultsItem.html +1 -0
- package/docs/interfaces/Models.SearchResultsItemComponentModel.html +1 -0
- package/docs/interfaces/Models.SearchResultsItemVariant.html +1 -0
- package/docs/interfaces/Models.SearchResultsListComponentModel.html +1 -0
- package/docs/interfaces/Models.SearchWithinFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.SelectedFacet.html +1 -0
- package/docs/interfaces/Models.SelectedFacetValue.html +1 -0
- package/docs/interfaces/Models.SelectedFacetsComponentModel.html +1 -0
- package/docs/interfaces/Models.SeoConfiguration.html +1 -0
- package/docs/interfaces/Models.SizeFacetComponentModel.html +1 -0
- package/docs/interfaces/Models.SizeFacetValue.html +1 -0
- package/docs/interfaces/Models.SmartResponseComponentModel.html +1 -0
- package/docs/interfaces/Models.SmartResponseRequest.html +1 -0
- package/docs/interfaces/Models.SmartResponseResponse.html +1 -0
- package/docs/interfaces/Models.SmartSearchFieldComponentModel.html +3 -2
- package/docs/interfaces/Models.Sorting.html +1 -0
- package/docs/interfaces/Models.SortingComponentModel.html +1 -0
- package/docs/interfaces/Models.SortingOption.html +1 -0
- package/docs/interfaces/Models.TabsComponentModel.html +1 -0
- package/docs/interfaces/Models.TooltipComponentModel.html +1 -0
- package/docs/interfaces/Models.VariantSelectorComponentModel.html +1 -0
- package/docs/interfaces/Models.Variants.html +1 -0
- package/docs/interfaces/Models.VisualSearchFieldComponentModel.html +1 -0
- package/docs/modules/Components.html +3 -1
- package/docs/modules/Models.html +3 -1
- package/docs/types/Models.FacetState.html +1 -0
- package/docs/types/Models.FacetType.html +1 -0
- package/docs/types/Models.FacetValueState.html +1 -0
- package/docs/types/Models.IconName.html +1 -0
- package/docs/types/Models.ItemType.html +1 -0
- package/docs/types/Models.MessageRole.html +1 -0
- package/docs/types/Models.RequestType.html +1 -0
- package/docs/types/Models.SearchResultsMode.html +1 -0
- package/docs/types/Models.SearchTypes.html +1 -0
- package/docs/types/Models.SelectedFacets.html +1 -0
- package/package.json +1 -1
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
</tbody></table>
|
|
35
35
|
<p>This partial renders a checkbox for each facet value along with any applicable actions (include, exclude, toggle).</p>
|
|
36
36
|
<p><em>Note: For more information, see <a href="../interfaces/Models.CheckboxListFacetValue.html" class="tsd-kind-interface">CheckboxListFacetValue</a>.</em></p>
|
|
37
|
-
<pre><code><span class="hl-2">{{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">length</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">ul</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-9">each</span><span class="hl-2"> </span><span class="hl-8">this</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">visible</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">li</span><br/><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item{{attribute ' checkbox-list-facet__list__item--excluded' excluded}}{{attribut</span><span class="hl-12">e</span><br/><span class="hl-2"> </span><span class="hl-7">' checkbox-list-facet__list__item--collapsible'</span><br/><span class="hl-2"> </span><span class="hl-9">hasChildren</span><br/><span class="hl-2"> }}</span><span class="hl-7">"</span><br/><span class="hl-7"> </span><span class="hl-12">></span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__content"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">selected</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">input</span><span class="hl-2"> </span><span class="hl-9">id</span><span class="hl-2">=</span><span class="hl-7">"{{@root.id}}-{{value}}"</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2">=</span><span class="hl-7">"checkbox"</span><span class="hl-2"> </span><span class="hl-9">checked</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2"> </span><span class="hl-9">value</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> /></span><br/><span class="hl-2"> {{</span><span class="hl-10">else</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">input</span><span class="hl-2"> </span><span class="hl-9">id</span><span class="hl-2">=</span><span class="hl-7">"{{@root.id}}-{{value}}"</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2">=</span><span class="hl-7">"checkbox"</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2"> </span><span class="hl-9">value</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> /></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">label</span><span class="hl-2"> </span><span class="hl-9">for</span><span class="hl-2">=</span><span class="hl-7">"{{@root.id}}-{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__value"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__value__title checkbox-list-facet__list__item__title"</span><span class="hl-2">>{{</span><span class="hl-9">title</span><span class="hl-2">}}</</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> @</span><span class="hl-9">root</span><span class="hl-2">.</span><span class="hl-9">displayCount</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__value__count checkbox-list-facet__list__item__count"</span><span class="hl-2">>({{</span><span class="hl-9">count</span><span class="hl-2">}})</</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">label</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">toggled</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{> </span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">checkbox</span><span class="hl-2">-</span><span class="hl-9">list</span><span class="hl-2"> </span><span class="hl-9">children</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">div</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> (</span><span class="hl-9">or</span><span class="hl-2"> @</span><span class="hl-9">root</span><span class="hl-2">.</span><span class="hl-9">excludeEnabled</span><span class="hl-2"> </span><span class="hl-9">hasChildren</span><span class="hl-2">)}}</span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> @</span><span class="hl-9">root</span><span class="hl-2">.</span><span class="hl-9">excludeEnabled</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">excluded</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">include</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{@root.strings.include}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"plus"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__heading__actions__item"</span><span class="hl-2">></</span><span class="hl-13">hawksearch</span><span class="hl-2">-</span><span class="hl-13">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{</span><span class="hl-10">else</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">exclude</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{@root.strings.exclude}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"minus"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__heading__actions__item"</span><span class="hl-2">></</span><span class="hl-13">hawksearch</span><span class="hl-2">-</span><span class="hl-13">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">hasChildren</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">toggle</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{if-else toggled @root.strings.collapse @root.strings.expand}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"{{if-else toggled 'chevron-down' 'chevron-right'}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__heading__toggle"</span><span class="hl-2">></</span><span class="hl-13">hawksearch</span><span class="hl-2">-</span><span class="hl-13">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">div</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">li</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-9">each</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">ul</span><span class="hl-2">></span><br/><span class="hl-2">{{/</span><span class="hl-10">if</span><span class="hl-2">}}</span>
|
|
37
|
+
<pre><code><span class="hl-2">{{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">length</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">ul</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-9">each</span><span class="hl-2"> </span><span class="hl-8">this</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">visible</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">li</span><br/><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item{{attribute ' checkbox-list-facet__list__item--excluded' excluded}}{{attribut</span><span class="hl-13">e</span><br/><span class="hl-2"> </span><span class="hl-7">' checkbox-list-facet__list__item--collapsible'</span><br/><span class="hl-2"> </span><span class="hl-9">hasChildren</span><br/><span class="hl-2"> }}</span><span class="hl-7">"</span><br/><span class="hl-7"> </span><span class="hl-13">></span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__content"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">selected</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">input</span><span class="hl-2"> </span><span class="hl-9">id</span><span class="hl-2">=</span><span class="hl-7">"{{@root.id}}-{{value}}"</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2">=</span><span class="hl-7">"checkbox"</span><span class="hl-2"> </span><span class="hl-9">checked</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2"> </span><span class="hl-9">value</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> /></span><br/><span class="hl-2"> {{</span><span class="hl-10">else</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">input</span><span class="hl-2"> </span><span class="hl-9">id</span><span class="hl-2">=</span><span class="hl-7">"{{@root.id}}-{{value}}"</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2">=</span><span class="hl-7">"checkbox"</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2"> </span><span class="hl-9">value</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> /></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">label</span><span class="hl-2"> </span><span class="hl-9">for</span><span class="hl-2">=</span><span class="hl-7">"{{@root.id}}-{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__value"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__value__title checkbox-list-facet__list__item__title"</span><span class="hl-2">>{{</span><span class="hl-9">title</span><span class="hl-2">}}</</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> @</span><span class="hl-9">root</span><span class="hl-2">.</span><span class="hl-9">displayCount</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__value__count checkbox-list-facet__list__item__count"</span><span class="hl-2">>({{</span><span class="hl-9">count</span><span class="hl-2">}})</</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">label</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">toggled</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{> </span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">checkbox</span><span class="hl-2">-</span><span class="hl-9">list</span><span class="hl-2"> </span><span class="hl-9">children</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">div</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> (</span><span class="hl-9">or</span><span class="hl-2"> @</span><span class="hl-9">root</span><span class="hl-2">.</span><span class="hl-9">excludeEnabled</span><span class="hl-2"> </span><span class="hl-9">hasChildren</span><span class="hl-2">)}}</span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> @</span><span class="hl-9">root</span><span class="hl-2">.</span><span class="hl-9">excludeEnabled</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">excluded</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">include</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{@root.strings.include}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"plus"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__heading__actions__item"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{</span><span class="hl-10">else</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">exclude</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{@root.strings.exclude}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"minus"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__heading__actions__item"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">hasChildren</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">toggle</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet__list__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{if-else toggled @root.strings.collapse @root.strings.expand}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"{{if-else toggled 'chevron-down' 'chevron-right'}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"facet__heading__toggle"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">div</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">li</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-9">each</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">ul</span><span class="hl-2">></span><br/><span class="hl-2">{{/</span><span class="hl-10">if</span><span class="hl-2">}}</span>
|
|
38
38
|
</code><button>Copy</button></pre>
|
|
39
39
|
<a id="md:default-template" class="tsd-anchor"></a><h2><a href="#md:default-template">Default Template</a></h2><p>The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.</p>
|
|
40
40
|
<pre><code><span class="hl-2"><</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"checkbox-list-facet"</span><span class="hl-2"> {{</span><span class="hl-6">attribute</span><span class="hl-2"> (</span><span class="hl-9">concat</span><span class="hl-2"> </span><span class="hl-7">'style="max-height: '</span><span class="hl-2"> </span><span class="hl-9">maxHeight</span><span class="hl-2"> </span><span class="hl-7">'px;"'</span><span class="hl-2">) </span><span class="hl-9">maxHeight</span><span class="hl-2">}}></span><br/><span class="hl-2"> {{> </span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">checkbox</span><span class="hl-2">-</span><span class="hl-9">list</span><span class="hl-2"> </span><span class="hl-9">values</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">showToggle</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">toggle</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"link facet__toggle"</span><span class="hl-2">>{{</span><span class="hl-9">strings</span><span class="hl-2">.</span><span class="hl-9">toggle</span><span class="hl-2">}}</</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"></</span><span class="hl-9">div</span><span class="hl-2">></span>
|
|
@@ -77,6 +77,7 @@
|
|
|
77
77
|
<a href="Components.CheckboxListFacetComponent.html#registerHelpers" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a>
|
|
78
78
|
<a href="Components.CheckboxListFacetComponent.html#render" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a>
|
|
79
79
|
<a href="Components.CheckboxListFacetComponent.html#renderContent" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a>
|
|
80
|
+
<a href="Components.CheckboxListFacetComponent.html#triggerEvent" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a>
|
|
80
81
|
</div></section></div></details></section></section>
|
|
81
82
|
<section class="tsd-panel-group tsd-member-group">
|
|
82
83
|
<h2>Properties</h2>
|
|
@@ -229,7 +230,26 @@
|
|
|
229
230
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.</p>
|
|
230
231
|
|
|
231
232
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
232
|
-
<p>Overrides <a href="Components.BaseFacetComponent.html">BaseFacetComponent</a>.<a href="Components.BaseFacetComponent.html#renderContent">renderContent</a></p></aside></li></ul></section
|
|
233
|
+
<p>Overrides <a href="Components.BaseFacetComponent.html">BaseFacetComponent</a>.<a href="Components.BaseFacetComponent.html#renderContent">renderContent</a></p></aside></li></ul></section>
|
|
234
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="triggerEvent" class="tsd-anchor"></a>
|
|
235
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>trigger<wbr/>Event</span><a href="#triggerEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
236
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
237
|
+
<li class="tsd-signature tsd-anchor-link" id="triggerEvent.triggerEvent-1"><span class="tsd-kind-call-signature">trigger<wbr/>Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#triggerEvent.triggerEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
238
|
+
<li class="tsd-description">
|
|
239
|
+
<section class="tsd-panel">
|
|
240
|
+
<h4>Type Parameters</h4>
|
|
241
|
+
<ul class="tsd-type-parameter-list">
|
|
242
|
+
<li>
|
|
243
|
+
<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
|
|
244
|
+
<div class="tsd-parameters">
|
|
245
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
246
|
+
<ul class="tsd-parameter-list">
|
|
247
|
+
<li>
|
|
248
|
+
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
249
|
+
<li>
|
|
250
|
+
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
|
|
251
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
252
|
+
<p>Inherited from <a href="Components.BaseFacetComponent.html">BaseFacetComponent</a>.<a href="Components.BaseFacetComponent.html#triggerEvent">triggerEvent</a></p></aside></li></ul></section></section></div>
|
|
233
253
|
<div class="col-sidebar">
|
|
234
254
|
<div class="page-menu">
|
|
235
255
|
<div class="tsd-navigation settings">
|
|
@@ -272,7 +292,8 @@
|
|
|
272
292
|
<li><a href="#onRender" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Render</span></a></li>
|
|
273
293
|
<li><a href="#registerHelpers" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a></li>
|
|
274
294
|
<li><a href="#render" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a></li>
|
|
275
|
-
<li><a href="#renderContent" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li
|
|
295
|
+
<li><a href="#renderContent" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li>
|
|
296
|
+
<li><a href="#triggerEvent" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a></li></ul></div></details></div>
|
|
276
297
|
<div class="site-menu">
|
|
277
298
|
<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>
|
|
278
299
|
<ul class="tsd-small-nested-navigation">
|
|
@@ -325,6 +346,7 @@
|
|
|
325
346
|
<li><a href="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>
|
|
326
347
|
<li><a href="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>
|
|
327
348
|
<li><a href="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>
|
|
349
|
+
<li><a href="Components.UnifiedSearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Unified<wbr/>Search<wbr/>Field<wbr/>Component</span></a></li>
|
|
328
350
|
<li><a href="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>
|
|
329
351
|
<li><a href="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>
|
|
330
352
|
<li><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></li>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
<a id="md:tag" class="tsd-anchor"></a><h2><a href="#md:tag">Tag</a></h2><p>The tag for this component is <code><hawksearch-color-facet></code>.</p>
|
|
22
22
|
<a id="md:event-binding-attributes" class="tsd-anchor"></a><h2><a href="#md:event-binding-attributes">Event-Binding Attributes</a></h2><p><em>Note: For Event-Binding attributes common to all facet type components, see <a href="Components.BaseFacetComponent.html" class="tsd-kind-class">BaseFacetComponent</a>.</em></p>
|
|
23
23
|
<a id="md:default-template" class="tsd-anchor"></a><h2><a href="#md:default-template">Default Template</a></h2><p>The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.</p>
|
|
24
|
-
<pre><code><span class="hl-2"><</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"row row--tight color-facet__items"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-9">each</span><span class="hl-2"> </span><span class="hl-9">values</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">visible</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"column column--2 color-facet__item{{attribute ' color-facet__item--selected' selected}}"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">color</span><span class="hl-2">.</span><span class="hl-9">imageUrl</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">img</span><span class="hl-2"> </span><span class="hl-9">src</span><span class="hl-2">=</span><span class="hl-7">"{{color.imageUrl}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet__item__image"</span><span class="hl-2"> </span><span class="hl-9">alt</span><span class="hl-2">=</span><span class="hl-7">"{{color.name}}"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{color.name}}"</span><span class="hl-2"> /></span><br/><span class="hl-2"> {{</span><span class="hl-10">else</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet__item__box"</span><span class="hl-2"> </span><span class="hl-9">style</span><span class="hl-2">=</span><span class="hl-7">"background: {{color.hex}};"</span><span class="hl-2">></</span><span class="hl-
|
|
24
|
+
<pre><code><span class="hl-2"><</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"row row--tight color-facet__items"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-9">each</span><span class="hl-2"> </span><span class="hl-9">values</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">visible</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"column column--2 color-facet__item{{attribute ' color-facet__item--selected' selected}}"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">color</span><span class="hl-2">.</span><span class="hl-9">imageUrl</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">img</span><span class="hl-2"> </span><span class="hl-9">src</span><span class="hl-2">=</span><span class="hl-7">"{{color.imageUrl}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet__item__image"</span><span class="hl-2"> </span><span class="hl-9">alt</span><span class="hl-2">=</span><span class="hl-7">"{{color.name}}"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{color.name}}"</span><span class="hl-2"> /></span><br/><span class="hl-2"> {{</span><span class="hl-10">else</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet__item__box"</span><span class="hl-2"> </span><span class="hl-9">style</span><span class="hl-2">=</span><span class="hl-7">"background: {{color.hex}};"</span><span class="hl-2">></</span><span class="hl-14">div</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> @</span><span class="hl-9">root</span><span class="hl-2">.</span><span class="hl-9">excludeEnabled</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet__item__actions"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">excluded</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">include</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{strings.include}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"plus"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{</span><span class="hl-10">else</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">value</span><span class="hl-2">-</span><span class="hl-9">exclude</span><span class="hl-2">=</span><span class="hl-7">"{{value}}"</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"color-facet__item__actions__item"</span><span class="hl-2"> </span><span class="hl-9">title</span><span class="hl-2">=</span><span class="hl-7">"{{strings.exclude}}"</span><span class="hl-2">></span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">icon</span><span class="hl-2"> </span><span class="hl-9">name</span><span class="hl-2">=</span><span class="hl-7">"minus"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">icon</span><span class="hl-2">></span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">div</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-9">each</span><span class="hl-2">}}</span><br/><span class="hl-2"> </</span><span class="hl-9">div</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> </span><span class="hl-9">showToggle</span><span class="hl-2">}}</span><br/><span class="hl-2"> <</span><span class="hl-9">span</span><span class="hl-2"> </span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">facet</span><span class="hl-2">-</span><span class="hl-9">toggle</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"link facet__toggle"</span><span class="hl-2">>{{</span><span class="hl-9">strings</span><span class="hl-2">.</span><span class="hl-9">toggle</span><span class="hl-2">}}</</span><span class="hl-9">span</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"></</span><span class="hl-9">div</span><span class="hl-2">></span>
|
|
25
25
|
</code><button>Copy</button></pre>
|
|
26
26
|
</div>
|
|
27
27
|
<div class="tsd-comment tsd-typography"></div></section>
|
|
@@ -61,6 +61,7 @@
|
|
|
61
61
|
<a href="Components.ColorFacetComponent.html#registerHelpers" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a>
|
|
62
62
|
<a href="Components.ColorFacetComponent.html#render" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a>
|
|
63
63
|
<a href="Components.ColorFacetComponent.html#renderContent" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a>
|
|
64
|
+
<a href="Components.ColorFacetComponent.html#triggerEvent" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a>
|
|
64
65
|
</div></section></div></details></section></section>
|
|
65
66
|
<section class="tsd-panel-group tsd-member-group">
|
|
66
67
|
<h2>Properties</h2>
|
|
@@ -213,7 +214,26 @@
|
|
|
213
214
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.</p>
|
|
214
215
|
|
|
215
216
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
216
|
-
<p>Overrides <a href="Components.BaseFacetComponent.html">BaseFacetComponent</a>.<a href="Components.BaseFacetComponent.html#renderContent">renderContent</a></p></aside></li></ul></section
|
|
217
|
+
<p>Overrides <a href="Components.BaseFacetComponent.html">BaseFacetComponent</a>.<a href="Components.BaseFacetComponent.html#renderContent">renderContent</a></p></aside></li></ul></section>
|
|
218
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="triggerEvent" class="tsd-anchor"></a>
|
|
219
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>trigger<wbr/>Event</span><a href="#triggerEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
220
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
221
|
+
<li class="tsd-signature tsd-anchor-link" id="triggerEvent.triggerEvent-1"><span class="tsd-kind-call-signature">trigger<wbr/>Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#triggerEvent.triggerEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
222
|
+
<li class="tsd-description">
|
|
223
|
+
<section class="tsd-panel">
|
|
224
|
+
<h4>Type Parameters</h4>
|
|
225
|
+
<ul class="tsd-type-parameter-list">
|
|
226
|
+
<li>
|
|
227
|
+
<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
|
|
228
|
+
<div class="tsd-parameters">
|
|
229
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
230
|
+
<ul class="tsd-parameter-list">
|
|
231
|
+
<li>
|
|
232
|
+
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
233
|
+
<li>
|
|
234
|
+
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
|
|
235
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
236
|
+
<p>Inherited from <a href="Components.BaseFacetComponent.html">BaseFacetComponent</a>.<a href="Components.BaseFacetComponent.html#triggerEvent">triggerEvent</a></p></aside></li></ul></section></section></div>
|
|
217
237
|
<div class="col-sidebar">
|
|
218
238
|
<div class="page-menu">
|
|
219
239
|
<div class="tsd-navigation settings">
|
|
@@ -255,7 +275,8 @@
|
|
|
255
275
|
<li><a href="#onRender" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Render</span></a></li>
|
|
256
276
|
<li><a href="#registerHelpers" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a></li>
|
|
257
277
|
<li><a href="#render" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a></li>
|
|
258
|
-
<li><a href="#renderContent" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li
|
|
278
|
+
<li><a href="#renderContent" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li>
|
|
279
|
+
<li><a href="#triggerEvent" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a></li></ul></div></details></div>
|
|
259
280
|
<div class="site-menu">
|
|
260
281
|
<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>
|
|
261
282
|
<ul class="tsd-small-nested-navigation">
|
|
@@ -308,6 +329,7 @@
|
|
|
308
329
|
<li><a href="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>
|
|
309
330
|
<li><a href="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>
|
|
310
331
|
<li><a href="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>
|
|
332
|
+
<li><a href="Components.UnifiedSearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Unified<wbr/>Search<wbr/>Field<wbr/>Component</span></a></li>
|
|
311
333
|
<li><a href="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>
|
|
312
334
|
<li><a href="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>
|
|
313
335
|
<li><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></li>
|
|
@@ -72,6 +72,7 @@
|
|
|
72
72
|
<a href="Components.ConceptSearchFieldComponent.html#registerHelpers" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a>
|
|
73
73
|
<a href="Components.ConceptSearchFieldComponent.html#render" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a>
|
|
74
74
|
<a href="Components.ConceptSearchFieldComponent.html#renderContent" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a>
|
|
75
|
+
<a href="Components.ConceptSearchFieldComponent.html#triggerEvent" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a>
|
|
75
76
|
</div></section></div></details></section></section>
|
|
76
77
|
<section class="tsd-panel-group tsd-member-group">
|
|
77
78
|
<h2>Properties</h2>
|
|
@@ -234,7 +235,26 @@
|
|
|
234
235
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.</p>
|
|
235
236
|
|
|
236
237
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
237
|
-
<p>Inherited from <a href="Components.BaseComponent.html">BaseComponent</a>.<a href="Components.BaseComponent.html#renderContent">renderContent</a></p></aside></li></ul></section
|
|
238
|
+
<p>Inherited from <a href="Components.BaseComponent.html">BaseComponent</a>.<a href="Components.BaseComponent.html#renderContent">renderContent</a></p></aside></li></ul></section>
|
|
239
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="triggerEvent" class="tsd-anchor"></a>
|
|
240
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>trigger<wbr/>Event</span><a href="#triggerEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
241
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
242
|
+
<li class="tsd-signature tsd-anchor-link" id="triggerEvent.triggerEvent-1"><span class="tsd-kind-call-signature">trigger<wbr/>Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#triggerEvent.triggerEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
243
|
+
<li class="tsd-description">
|
|
244
|
+
<section class="tsd-panel">
|
|
245
|
+
<h4>Type Parameters</h4>
|
|
246
|
+
<ul class="tsd-type-parameter-list">
|
|
247
|
+
<li>
|
|
248
|
+
<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
|
|
249
|
+
<div class="tsd-parameters">
|
|
250
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
251
|
+
<ul class="tsd-parameter-list">
|
|
252
|
+
<li>
|
|
253
|
+
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
254
|
+
<li>
|
|
255
|
+
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
|
|
256
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
257
|
+
<p>Inherited from <a href="Components.BaseComponent.html">BaseComponent</a>.<a href="Components.BaseComponent.html#triggerEvent">triggerEvent</a></p></aside></li></ul></section></section></div>
|
|
238
258
|
<div class="col-sidebar">
|
|
239
259
|
<div class="page-menu">
|
|
240
260
|
<div class="tsd-navigation settings">
|
|
@@ -277,7 +297,8 @@
|
|
|
277
297
|
<li><a href="#onRender" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Render</span></a></li>
|
|
278
298
|
<li><a href="#registerHelpers" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a></li>
|
|
279
299
|
<li><a href="#render" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a></li>
|
|
280
|
-
<li><a href="#renderContent" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li
|
|
300
|
+
<li><a href="#renderContent" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li>
|
|
301
|
+
<li><a href="#triggerEvent" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a></li></ul></div></details></div>
|
|
281
302
|
<div class="site-menu">
|
|
282
303
|
<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>
|
|
283
304
|
<ul class="tsd-small-nested-navigation">
|
|
@@ -330,6 +351,7 @@
|
|
|
330
351
|
<li><a href="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>
|
|
331
352
|
<li><a href="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>
|
|
332
353
|
<li><a href="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>
|
|
354
|
+
<li><a href="Components.UnifiedSearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Unified<wbr/>Search<wbr/>Field<wbr/>Component</span></a></li>
|
|
333
355
|
<li><a href="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>
|
|
334
356
|
<li><a href="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>
|
|
335
357
|
<li><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></li>
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
</tbody></table>
|
|
49
49
|
<p>To render a content item, the <code>index</code> attribute must be present with a value corresponding to the item’s index in the <a href="../interfaces/Models.ContentZoneComponentModel.html#items" class="tsd-kind-property">items</a> array.</p>
|
|
50
50
|
<a id="md:default-template" class="tsd-anchor"></a><h2><a href="#md:default-template">Default Template</a></h2><p>The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.</p>
|
|
51
|
-
<pre><code><span class="hl-2"><</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"content-zone"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-9">each</span><span class="hl-2"> </span><span class="hl-9">items</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> (</span><span class="hl-9">eq</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2"> </span><span class="hl-7">"custom"</span><span class="hl-2">)}}</span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">custom</span><span class="hl-2">-</span><span class="hl-9">content</span><span class="hl-2"> </span><span class="hl-9">index</span><span class="hl-2">=</span><span class="hl-7">"{{@index}}"</span><span class="hl-2">></</span><span class="hl-
|
|
51
|
+
<pre><code><span class="hl-2"><</span><span class="hl-9">div</span><span class="hl-2"> </span><span class="hl-9">class</span><span class="hl-2">=</span><span class="hl-7">"content-zone"</span><span class="hl-2">></span><br/><span class="hl-2"> {{#</span><span class="hl-9">each</span><span class="hl-2"> </span><span class="hl-9">items</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> (</span><span class="hl-9">eq</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2"> </span><span class="hl-7">"custom"</span><span class="hl-2">)}}</span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">custom</span><span class="hl-2">-</span><span class="hl-9">content</span><span class="hl-2"> </span><span class="hl-9">index</span><span class="hl-2">=</span><span class="hl-7">"{{@index}}"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">custom</span><span class="hl-2">-</span><span class="hl-14">content</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> (</span><span class="hl-9">eq</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2"> </span><span class="hl-7">"featured-items"</span><span class="hl-2">)}}</span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">featured</span><span class="hl-2">-</span><span class="hl-9">items</span><span class="hl-2">-</span><span class="hl-9">content</span><span class="hl-2"> </span><span class="hl-9">index</span><span class="hl-2">=</span><span class="hl-7">"{{@index}}"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">featured</span><span class="hl-2">-</span><span class="hl-14">items</span><span class="hl-2">-</span><span class="hl-14">content</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> (</span><span class="hl-9">eq</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2"> </span><span class="hl-7">"image"</span><span class="hl-2">)}}</span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">image</span><span class="hl-2">-</span><span class="hl-9">content</span><span class="hl-2"> </span><span class="hl-9">index</span><span class="hl-2">=</span><span class="hl-7">"{{@index}}"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">image</span><span class="hl-2">-</span><span class="hl-14">content</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{#</span><span class="hl-10">if</span><span class="hl-2"> (</span><span class="hl-9">eq</span><span class="hl-2"> </span><span class="hl-9">type</span><span class="hl-2"> </span><span class="hl-7">"popular-queries"</span><span class="hl-2">)}}</span><br/><span class="hl-2"> <</span><span class="hl-9">hawksearch</span><span class="hl-2">-</span><span class="hl-9">popular</span><span class="hl-2">-</span><span class="hl-9">queries</span><span class="hl-2">-</span><span class="hl-9">content</span><span class="hl-2"> </span><span class="hl-9">index</span><span class="hl-2">=</span><span class="hl-7">"{{@index}}"</span><span class="hl-2">></</span><span class="hl-14">hawksearch</span><span class="hl-2">-</span><span class="hl-14">popular</span><span class="hl-2">-</span><span class="hl-14">queries</span><span class="hl-2">-</span><span class="hl-14">content</span><span class="hl-2">></span><br/><span class="hl-2"> {{/</span><span class="hl-10">if</span><span class="hl-2">}}</span><br/><span class="hl-2"> {{/</span><span class="hl-9">each</span><span class="hl-2">}}</span><br/><span class="hl-2"></</span><span class="hl-9">div</span><span class="hl-2">></span>
|
|
52
52
|
</code><button>Copy</button></pre>
|
|
53
53
|
</div>
|
|
54
54
|
<div class="tsd-comment tsd-typography"></div></section>
|
|
@@ -89,6 +89,7 @@
|
|
|
89
89
|
<a href="Components.ContentZoneComponent.html#registerHelpers" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a>
|
|
90
90
|
<a href="Components.ContentZoneComponent.html#render" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a>
|
|
91
91
|
<a href="Components.ContentZoneComponent.html#renderContent" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a>
|
|
92
|
+
<a href="Components.ContentZoneComponent.html#triggerEvent" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a>
|
|
92
93
|
</div></section></div></details></section></section>
|
|
93
94
|
<section class="tsd-panel-group tsd-member-group">
|
|
94
95
|
<h2>Properties</h2>
|
|
@@ -251,7 +252,26 @@
|
|
|
251
252
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.</p>
|
|
252
253
|
|
|
253
254
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
254
|
-
<p>Overrides <a href="Components.BaseComponent.html">BaseComponent</a>.<a href="Components.BaseComponent.html#renderContent">renderContent</a></p></aside></li></ul></section
|
|
255
|
+
<p>Overrides <a href="Components.BaseComponent.html">BaseComponent</a>.<a href="Components.BaseComponent.html#renderContent">renderContent</a></p></aside></li></ul></section>
|
|
256
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="triggerEvent" class="tsd-anchor"></a>
|
|
257
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>trigger<wbr/>Event</span><a href="#triggerEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
258
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
|
|
259
|
+
<li class="tsd-signature tsd-anchor-link" id="triggerEvent.triggerEvent-1"><span class="tsd-kind-call-signature">trigger<wbr/>Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#triggerEvent.triggerEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
260
|
+
<li class="tsd-description">
|
|
261
|
+
<section class="tsd-panel">
|
|
262
|
+
<h4>Type Parameters</h4>
|
|
263
|
+
<ul class="tsd-type-parameter-list">
|
|
264
|
+
<li>
|
|
265
|
+
<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
|
|
266
|
+
<div class="tsd-parameters">
|
|
267
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
268
|
+
<ul class="tsd-parameter-list">
|
|
269
|
+
<li>
|
|
270
|
+
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
271
|
+
<li>
|
|
272
|
+
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
|
|
273
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
274
|
+
<p>Inherited from <a href="Components.BaseComponent.html">BaseComponent</a>.<a href="Components.BaseComponent.html#triggerEvent">triggerEvent</a></p></aside></li></ul></section></section></div>
|
|
255
275
|
<div class="col-sidebar">
|
|
256
276
|
<div class="page-menu">
|
|
257
277
|
<div class="tsd-navigation settings">
|
|
@@ -295,7 +315,8 @@
|
|
|
295
315
|
<li><a href="#onRender" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on<wbr/>Render</span></a></li>
|
|
296
316
|
<li><a href="#registerHelpers" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Helpers</span></a></li>
|
|
297
317
|
<li><a href="#render" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render</span></a></li>
|
|
298
|
-
<li><a href="#renderContent" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li
|
|
318
|
+
<li><a href="#renderContent" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Content</span></a></li>
|
|
319
|
+
<li><a href="#triggerEvent" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Event</span></a></li></ul></div></details></div>
|
|
299
320
|
<div class="site-menu">
|
|
300
321
|
<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>
|
|
301
322
|
<ul class="tsd-small-nested-navigation">
|
|
@@ -348,6 +369,7 @@
|
|
|
348
369
|
<li><a href="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>
|
|
349
370
|
<li><a href="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>
|
|
350
371
|
<li><a href="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>
|
|
372
|
+
<li><a href="Components.UnifiedSearchFieldComponent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Unified<wbr/>Search<wbr/>Field<wbr/>Component</span></a></li>
|
|
351
373
|
<li><a href="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>
|
|
352
374
|
<li><a href="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>
|
|
353
375
|
<li><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></li>
|