npm - @bridgeline-digital/hawksearch-handlebars-ui - Versions diffs - 6.1.6 → 6.1.7 - Mend

@bridgeline-digital/hawksearch-handlebars-ui 6.1.6 → 6.1.7

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.

Files changed (747) hide show

package/docs/v5.2.0/data/Components.Class.SearchResultsComponent.json DELETED Viewed

@@ -1 +0,0 @@

- {"id":35369,"name":"SearchResultsComponent","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"The Search Results component encapsulates all components relating to search-results.\n\n## Tag\nThe tag for this component is "},{"kind":"code","text":"`<hawksearch-search-results>`"},{"kind":"text","text":".\n\n## Default Template\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n"},{"kind":"code","text":"```\n<hawksearch-modified-query></hawksearch-modified-query>\n<hawksearch-query-suggestions></hawksearch-query-suggestions>\n<div class=\"row\">\n <div class=\"column column--12 column-md--4\">\n <hawksearch-content-zone name=\"LeftTop\"></hawksearch-content-zone>\n <hawksearch-facets-list></hawksearch-facets-list>\n <hawksearch-content-zone name=\"LeftBottom\"></hawksearch-content-zone>\n </div>\n <div class=\"column column--12 column-md--8\">\n <hawksearch-content-zone name=\"Top\"></hawksearch-content-zone>\n <hawksearch-content-zone name=\"Top2\"></hawksearch-content-zone>\n <hawksearch-tabs></hawksearch-tabs>\n <hawksearch-selected-facets></hawksearch-selected-facets>\n <div class=\"row\">\n <div class=\"column column--12 column-sm--6 flex-vertical-sm-center\">\n <hawksearch-pagination></hawksearch-pagination>\n </div>\n <div class=\"column column--12 column-md--6\">\n <div class=\"row row--tight\">\n <div class=\"column column--12 column-sm--6 flex-vertical-sm-center\">\n <hawksearch-page-size></hawksearch-page-size>\n </div>\n <div class=\"column column--12 column-sm--6 flex-vertical-sm-center\">\n <hawksearch-sorting></hawksearch-sorting>\n </div>\n </div>\n </div>\n </div>\n <hawksearch-search-results-list></hawksearch-search-results-list>\n <hawksearch-content-zone name=\"Bottom\"></hawksearch-content-zone>\n <hawksearch-content-zone name=\"Bottom2\"></hawksearch-content-zone>\n </div>\n</div>\n```"}]},"children":[{"id":35370,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isOverride":true},"signatures":[{"id":35371,"name":"constructor","kind":16384,"kindString":"Constructor signature","flags":{"isOverride":true},"type":{"type":"reference","id":35369,"name":"SearchResultsComponent"},"overwrites":{"type":"reference","name":"BaseComponent<SearchResultsComponentConfig, SearchResponse, SearchResultsComponentModel>.constructor"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Constructor.constructor","hash":"constructor.new SearchResultsComponent"},"text":{},"parentId":35370}],"overwrites":{"type":"reference","name":"BaseComponent<SearchResultsComponentConfig, SearchResponse, SearchResultsComponentModel>.constructor"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"constructor"},"text":{},"parentId":35369},{"id":35374,"name":"bindFromEvent","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true","overwrites":{"type":"reference","name":"BaseComponent.bindFromEvent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"bindFromEvent"},"text":{},"parentId":35369},{"id":35372,"name":"componentName","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","id":40340,"name":"HawkSearchComponents"}},"defaultValue":"'search-results'","overwrites":{"type":"reference","name":"BaseComponent.componentName"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"componentName"},"text":{},"parentId":35369},{"id":35381,"name":"configOverride","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional instance-level configuration to override the global configuration"}]},"type":{"type":"reference","id":40294,"name":"SearchResultsComponentConfig"},"inheritedFrom":{"type":"reference","id":12,"name":"BaseComponent.configOverride"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"configOverride"},"text":{"comment":"Optional instance-level configuration to override the global configuration\n"},"parentId":35369},{"id":35385,"name":"contentModel","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the Handlebars template."}]},"type":{"type":"reference","id":41024,"name":"SearchResultsComponentModel"},"inheritedFrom":{"type":"reference","id":16,"name":"BaseComponent.contentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"contentModel"},"text":{"comment":"The data bound to the Handlebars template.\n"},"parentId":35369},{"id":35382,"name":"data","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the component."}]},"type":{"type":"reference","id":41351,"name":"SearchResponse"},"inheritedFrom":{"type":"reference","id":13,"name":"BaseComponent.data"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"data"},"text":{"comment":"The data bound to the component.\n"},"parentId":35369},{"id":35373,"name":"defaultHtml","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"any"},"defaultValue":"defaultHtml","overwrites":{"type":"reference","name":"BaseComponent.defaultHtml"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"defaultHtml"},"text":{},"parentId":35369},{"id":35383,"name":"handlebars","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The Handlebars reference shared by all HawkSearch components."}]},"type":{"type":"query","queryType":{"type":"reference","name":"Handlebars","qualifiedName":"Handlebars","package":"handlebars"}},"defaultValue":"HawkSearch.handlebars","inheritedFrom":{"type":"reference","id":14,"name":"BaseComponent.handlebars"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"handlebars"},"text":{"comment":"The Handlebars reference shared by all HawkSearch components.\n"},"parentId":35369},{"id":35386,"name":"configuration","kind":262144,"kindString":"Accessor","flags":{"isProtected":true,"isInherited":true},"getSignature":{"id":35387,"name":"configuration","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The optional configuration object for this component."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reference","name":"TConfig"}]},"inheritedFrom":{"type":"reference","name":"BaseComponent.configuration"},"text":{"comment":"The optional configuration object for this component.\n"}},"inheritedFrom":{"type":"reference","id":20,"name":"BaseComponent.configuration"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"configuration"},"text":{},"parentId":35369},{"id":35375,"name":"mode","kind":262144,"kindString":"Accessor","flags":{"isProtected":true},"getSignature":{"id":35376,"name":"mode","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Speficies the context that the component is being used. This is determined by the "},{"kind":"code","text":"`mode`"},{"kind":"text","text":" attribute on the HTML element."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`'search-results'`"}]}]},"type":{"type":"reference","id":40724,"name":"SearchResultsMode"},"text":{"comment":"Speficies the context that the component is being used. This is determined by the <code>mode</code> attribute on the HTML element.\n<h5>Defaultvalue:</h5><code>'search-results'</code>\n"}},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"mode"},"text":{},"parentId":35369},{"id":35390,"name":"rootElement","kind":262144,"kindString":"Accessor","flags":{"isPublic":true,"isInherited":true},"getSignature":{"id":35391,"name":"rootElement","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The root element which should be used for querying any child elements. This resolves to "},{"kind":"code","text":"`this.shadowRoot`"},{"kind":"text","text":" if the Shadow DOM is enabled, otherwise "},{"kind":"code","text":"`this`"},{"kind":"text","text":"."}]},"type":{"type":"reference","name":"ParentNode","qualifiedName":"ParentNode","package":"typescript"},"inheritedFrom":{"type":"reference","name":"BaseComponent.rootElement"},"text":{"comment":"The root element which should be used for querying any child elements. This resolves to <code>this.shadowRoot</code> if the Shadow DOM is enabled, otherwise <code>this</code>.\n"}},"inheritedFrom":{"type":"reference","id":24,"name":"BaseComponent.rootElement"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"rootElement"},"text":{},"parentId":35369},{"id":35377,"name":"url","kind":262144,"kindString":"Accessor","flags":{"isProtected":true},"getSignature":{"id":35378,"name":"url","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"If "},{"kind":"inline-tag","tag":"@link","text":"mode","target":35375},{"kind":"text","text":" is set to "},{"kind":"code","text":"`'landing-page'`"},{"kind":"text","text":", this specifies the URL sent to retrieve content from HawkSearch. This can be customized by setting the "},{"kind":"code","text":"`url`"},{"kind":"text","text":" attribute on the HTML element."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`window.location.pathname`"}]}]},"type":{"type":"intrinsic","name":"string"},"text":{"comment":"If <a href=\"35375\">mode</a> is set to <code>'landing-page'</code>, this specifies the URL sent to retrieve content from HawkSearch. This can be customized by setting the <code>url</code> attribute on the HTML element.\n<h5>Defaultvalue:</h5><code>window.location.pathname</code>\n"}},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"url"},"text":{},"parentId":35369},{"id":35404,"name":"bindChildElements","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":35405,"name":"bindChildElements","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called to bind any child components."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":43,"name":"BaseComponent.bindChildElements"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Method.bindChildElements","hash":"bindChildElements.bindChildElements"},"text":{"comment":"After the component is rendered, this method is called to bind any child components.\n"},"parentId":35404}],"inheritedFrom":{"type":"reference","id":42,"name":"BaseComponent.bindChildElements"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"bindChildElements"},"text":{},"parentId":35369},{"id":35379,"name":"getContentModel","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":35380,"name":"getContentModel","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"type":{"type":"reference","id":41024,"name":"SearchResultsComponentModel"},"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Method.getContentModel","hash":"getContentModel.getContentModel"},"text":{},"parentId":35379}],"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"getContentModel"},"text":{},"parentId":35369},{"id":35408,"name":"interpolate","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":35409,"name":"interpolate","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Replaces placeholders in a given string with values from a data object."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The "},{"kind":"code","text":"`template`"},{"kind":"text","text":" string with all placeholders replaced by the values specified in "},{"kind":"code","text":"`values`"},{"kind":"text","text":"."}]}]},"parameters":[{"id":35410,"name":"template","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The template string."}]},"type":{"type":"intrinsic","name":"string"},"text":{"comment":"The template string.\n"}},{"id":35411,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The object containing properties which will be bound to "},{"kind":"code","text":"`template`"},{"kind":"text","text":"."}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","qualifiedName":"Record","package":"typescript"},"text":{"comment":"The object containing properties which will be bound to <code>template</code>.\n"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":49,"name":"BaseComponent.interpolate"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Method.interpolate","hash":"interpolate.interpolate"},"text":{"comment":"Replaces placeholders in a given string with values from a data object.\n<h5>Returns:</h5>The <code>template</code> string with all placeholders replaced by the values specified in <code>values</code>.\n"},"parentId":35408}],"inheritedFrom":{"type":"reference","id":48,"name":"BaseComponent.interpolate"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"interpolate"},"text":{},"parentId":35369},{"id":35406,"name":"onRender","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":35407,"name":"onRender","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":45,"name":"BaseComponent.onRender"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Method.onRender","hash":"onRender.onRender"},"text":{"comment":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.\n"},"parentId":35406}],"inheritedFrom":{"type":"reference","id":44,"name":"BaseComponent.onRender"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"onRender"},"text":{},"parentId":35369},{"id":35398,"name":"registerHelpers","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":35399,"name":"registerHelpers","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers)."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":35,"name":"BaseComponent.registerHelpers"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Method.registerHelpers","hash":"registerHelpers.registerHelpers"},"text":{"comment":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see <a href=\"https://handlebarsjs.com/guide/#custom-helpers\">Custom Helpers</a>.\n"},"parentId":35398}],"inheritedFrom":{"type":"reference","id":34,"name":"BaseComponent.registerHelpers"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"registerHelpers"},"text":{},"parentId":35369},{"id":35400,"name":"render","kind":2048,"kindString":"Method","flags":{"isPublic":true,"isInherited":true},"signatures":[{"id":35401,"name":"render","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Binds "},{"kind":"inline-tag","tag":"@link","text":"contentModel","target":35385},{"kind":"text","text":" to the Handlebars template and renders the resulting HTML content."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":37,"name":"BaseComponent.render"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Method.render","hash":"render.render"},"text":{"comment":"Binds <a href=\"35385\">contentModel</a> to the Handlebars template and renders the resulting HTML content.\n"},"parentId":35400}],"inheritedFrom":{"type":"reference","id":36,"name":"BaseComponent.render"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"render"},"text":{},"parentId":35369},{"id":35402,"name":"renderContent","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":35403,"name":"renderContent","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Determines whether the "},{"kind":"inline-tag","tag":"@link","text":"data","target":35382},{"kind":"text","text":" meets the necessary conditions to perform data binding and render content."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Whether the component should be rendered. If "},{"kind":"code","text":"`false`"},{"kind":"text","text":", the component will have empty contents and be set to "},{"kind":"code","text":"`display: none;`"},{"kind":"text","text":"."}]}]},"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":39,"name":"BaseComponent.renderContent"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsComponent.Method.renderContent","hash":"renderContent.renderContent"},"text":{"comment":"Determines whether the <a href=\"35382\">data</a> meets the necessary conditions to perform data binding and render content.\n<h5>Returns:</h5>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.\n"},"parentId":35402}],"inheritedFrom":{"type":"reference","id":38,"name":"BaseComponent.renderContent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":"renderContent"},"text":{},"parentId":35369}],"groups":[{"title":"Constructors","children":[35370]},{"title":"Properties","children":[35374,35372,35381,35385,35382,35373,35383]},{"title":"Accessors","children":[35386,35375,35390,35377]},{"title":"Methods","children":[35404,35379,35408,35406,35398,35400,35402]}],"extendedTypes":[{"type":"reference","id":6,"typeArguments":[{"type":"reference","id":40294,"name":"SearchResultsComponentConfig"},{"type":"reference","id":41351,"name":"SearchResponse"},{"type":"reference","id":41024,"name":"SearchResultsComponentModel"}],"name":"BaseComponent"}],"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsComponent","hash":""},"text":{"comment":"The Search Results component encapsulates all components relating to search-results.\n\n<a href=\"#tag\" id=\"tag\" style=\"color: inherit; text-decoration: none;\">\n <h2>Tag</h2>\n</a>\nThe tag for this component is <code><hawksearch-search-results></code>.\n\n<a href=\"#default-template\" id=\"default-template\" style=\"color: inherit; text-decoration: none;\">\n <h2>Default Template</h2>\n</a>\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n<pre><code><hawksearch-modified-query></hawksearch-modified-query>\n<hawksearch-query-suggestions></hawksearch-query-suggestions>\n<div class=\"row\">\n <div class=\"column column--12 column-md--4\">\n <hawksearch-content-zone name=\"LeftTop\"></hawksearch-content-zone>\n <hawksearch-facets-list></hawksearch-facets-list>\n <hawksearch-content-zone name=\"LeftBottom\"></hawksearch-content-zone>\n </div>\n <div class=\"column column--12 column-md--8\">\n <hawksearch-content-zone name=\"Top\"></hawksearch-content-zone>\n <hawksearch-content-zone name=\"Top2\"></hawksearch-content-zone>\n <hawksearch-tabs></hawksearch-tabs>\n <hawksearch-selected-facets></hawksearch-selected-facets>\n <div class=\"row\">\n <div class=\"column column--12 column-sm--6 flex-vertical-sm-center\">\n <hawksearch-pagination></hawksearch-pagination>\n </div>\n <div class=\"column column--12 column-md--6\">\n <div class=\"row row--tight\">\n <div class=\"column column--12 column-sm--6 flex-vertical-sm-center\">\n <hawksearch-page-size></hawksearch-page-size>\n </div>\n <div class=\"column column--12 column-sm--6 flex-vertical-sm-center\">\n <hawksearch-sorting></hawksearch-sorting>\n </div>\n </div>\n </div>\n </div>\n <hawksearch-search-results-list></hawksearch-search-results-list>\n <hawksearch-content-zone name=\"Bottom\"></hawksearch-content-zone>\n <hawksearch-content-zone name=\"Bottom2\"></hawksearch-content-zone>\n </div>\n</div>\n</code></pre>\n"},"parentId":1,"hierarchy":[{"name":"BaseComponent<SearchResultsComponentConfig, SearchResponse, SearchResultsComponentModel>","linkId":"6","children":[{"name":"SearchResultsComponent","isTarget":true,"linkId":"35369"}]}]}

package/docs/v5.2.0/data/Components.Class.SearchResultsItemComponent.json DELETED Viewed

@@ -1 +0,0 @@

- {"id":33471,"name":"SearchResultsItemComponent","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"The Search Results Item component displays information for an individual product or page.\n\n## Tag\nThe tag for this component is "},{"kind":"code","text":"`<hawksearch-search-results-item>`"},{"kind":"text","text":".\n\n*Note: This component should only be used within the context of the "},{"kind":"inline-tag","tag":"@link","text":"Search Results List component","target":34420},{"kind":"text","text":".\n\n## Event-Binding Attributes\n| Name | Value |\n| :- | :- |\n| hawksearch-image | |\n\nImage elements with this attribute will have their "},{"kind":"code","text":"`src`"},{"kind":"text","text":" value replaced with a placeholder image URL if the image fails to load.\n\n| Name | Value |\n| :- | :- |\n| hawksearch-link | |\n\nAnchor elements with this attribute will be tracked when clicked.\n\n## Default Template\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n"},{"kind":"code","text":"```\n<div class=\"search-results-list__item search-results-list__item--{{type}}\">\n {{#if pinned}}\n \n <hawksearch-icon name=\"star\"></hawksearch-icon>\n \n {{/if}}\n {{#if (eq type \"product\")}}\n {{#if (lt salePrice price)}}\n {{strings.sale}}\n {{/if}}\n <a hawksearch-link href=\"{{url}}\" class=\"search-results-list__item__image\" aria-label=\"{{title}}\">\n <img hawksearch-image src=\"{{imageUrl}}\" alt=\"\" />\n </a>\n <div class=\"search-results-list__item__title\">\n <a hawksearch-link href=\"{{url}}\">{{title}}</a>\n </div>\n {{#if rating}}\n <hawksearch-rating rating=\"{{rating}}\"></hawksearch-rating>\n {{/if}}\n {{#unless (eq price undefined)}}\n <div class=\"search-results-list__item__price\" itemprop=\"offers\" itemtype=\"http://schema.org/Offer\" itemscope>\n {{#if (lt salePrice price)}}\n {{currency price}}\n {{currency salePrice}}\n {{else}}\n {{currency price}}\n {{/if}}\n </div>\n {{/unless}}\n <hawksearch-variant-selector></hawksearch-variant-selector>\n {{else}}\n <div class=\"row\">\n {{#if imageUrl}}\n <div class=\"column column--12 column-sm--4\">\n <a hawksearch-link href=\"{{url}}\">\n <img hawksearch-image src=\"{{imageUrl}}\" alt=\"\" />\n </a>\n </div>\n {{/if}}\n <div class=\"column column--12 column-sm--8 flex-align-self-sm-center\">\n <div class=\"search-results-list__item__title\">\n <a hawksearch-link href=\"{{url}}\">{{title}}</a>\n </div>\n {{#if description}}\n {{description}}\n {{/if}}\n </div>\n </div>\n {{/if}}\n</div>\n```"}]},"children":[{"id":33476,"name":"bindFromEvent","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false","overwrites":{"type":"reference","name":"BaseComponent.bindFromEvent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"bindFromEvent"},"text":{},"parentId":33471},{"id":33474,"name":"componentName","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","id":40340,"name":"HawkSearchComponents"}},"defaultValue":"'search-results-item'","overwrites":{"type":"reference","name":"BaseComponent.componentName"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"componentName"},"text":{},"parentId":33471},{"id":33483,"name":"configOverride","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional instance-level configuration to override the global configuration"}]},"type":{"type":"reference","id":40297,"name":"SearchResultsItemComponentConfig"},"inheritedFrom":{"type":"reference","id":12,"name":"BaseComponent.configOverride"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"configOverride"},"text":{"comment":"Optional instance-level configuration to override the global configuration\n"},"parentId":33471},{"id":33487,"name":"contentModel","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the Handlebars template."}]},"type":{"type":"reference","id":41040,"name":"SearchResultsItemComponentModel"},"inheritedFrom":{"type":"reference","id":16,"name":"BaseComponent.contentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"contentModel"},"text":{"comment":"The data bound to the Handlebars template.\n"},"parentId":33471},{"id":33484,"name":"data","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the component."}]},"type":{"type":"reference","id":41334,"name":"SearchResultsItem"},"inheritedFrom":{"type":"reference","id":13,"name":"BaseComponent.data"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"data"},"text":{"comment":"The data bound to the component.\n"},"parentId":33471},{"id":33475,"name":"defaultHtml","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"any"},"defaultValue":"defaultHtml","overwrites":{"type":"reference","name":"BaseComponent.defaultHtml"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"defaultHtml"},"text":{},"parentId":33471},{"id":33485,"name":"handlebars","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The Handlebars reference shared by all HawkSearch components."}]},"type":{"type":"query","queryType":{"type":"reference","name":"Handlebars","qualifiedName":"Handlebars","package":"handlebars"}},"defaultValue":"HawkSearch.handlebars","inheritedFrom":{"type":"reference","id":14,"name":"BaseComponent.handlebars"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"handlebars"},"text":{"comment":"The Handlebars reference shared by all HawkSearch components.\n"},"parentId":33471},{"id":33488,"name":"configuration","kind":262144,"kindString":"Accessor","flags":{"isProtected":true,"isInherited":true},"getSignature":{"id":33489,"name":"configuration","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The optional configuration object for this component."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reference","name":"TConfig"}]},"inheritedFrom":{"type":"reference","name":"BaseComponent.configuration"},"text":{"comment":"The optional configuration object for this component.\n"}},"inheritedFrom":{"type":"reference","id":20,"name":"BaseComponent.configuration"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"configuration"},"text":{},"parentId":33471},{"id":33492,"name":"rootElement","kind":262144,"kindString":"Accessor","flags":{"isPublic":true,"isInherited":true},"getSignature":{"id":33493,"name":"rootElement","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The root element which should be used for querying any child elements. This resolves to "},{"kind":"code","text":"`this.shadowRoot`"},{"kind":"text","text":" if the Shadow DOM is enabled, otherwise "},{"kind":"code","text":"`this`"},{"kind":"text","text":"."}]},"type":{"type":"reference","name":"ParentNode","qualifiedName":"ParentNode","package":"typescript"},"inheritedFrom":{"type":"reference","name":"BaseComponent.rootElement"},"text":{"comment":"The root element which should be used for querying any child elements. This resolves to <code>this.shadowRoot</code> if the Shadow DOM is enabled, otherwise <code>this</code>.\n"}},"inheritedFrom":{"type":"reference","id":24,"name":"BaseComponent.rootElement"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"rootElement"},"text":{},"parentId":33471},{"id":33504,"name":"bindChildElements","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":33505,"name":"bindChildElements","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called to bind any child components."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":43,"name":"BaseComponent.bindChildElements"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsItemComponent.Method.bindChildElements","hash":"bindChildElements.bindChildElements"},"text":{"comment":"After the component is rendered, this method is called to bind any child components.\n"},"parentId":33504}],"inheritedFrom":{"type":"reference","id":42,"name":"BaseComponent.bindChildElements"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"bindChildElements"},"text":{},"parentId":33471},{"id":33479,"name":"getContentModel","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":33480,"name":"getContentModel","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"type":{"type":"reference","id":41040,"name":"SearchResultsItemComponentModel"},"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsItemComponent.Method.getContentModel","hash":"getContentModel.getContentModel"},"text":{},"parentId":33479}],"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"getContentModel"},"text":{},"parentId":33471},{"id":33506,"name":"interpolate","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":33507,"name":"interpolate","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Replaces placeholders in a given string with values from a data object."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The "},{"kind":"code","text":"`template`"},{"kind":"text","text":" string with all placeholders replaced by the values specified in "},{"kind":"code","text":"`values`"},{"kind":"text","text":"."}]}]},"parameters":[{"id":33508,"name":"template","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The template string."}]},"type":{"type":"intrinsic","name":"string"},"text":{"comment":"The template string.\n"}},{"id":33509,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The object containing properties which will be bound to "},{"kind":"code","text":"`template`"},{"kind":"text","text":"."}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","qualifiedName":"Record","package":"typescript"},"text":{"comment":"The object containing properties which will be bound to <code>template</code>.\n"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":49,"name":"BaseComponent.interpolate"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsItemComponent.Method.interpolate","hash":"interpolate.interpolate"},"text":{"comment":"Replaces placeholders in a given string with values from a data object.\n<h5>Returns:</h5>The <code>template</code> string with all placeholders replaced by the values specified in <code>values</code>.\n"},"parentId":33506}],"inheritedFrom":{"type":"reference","id":48,"name":"BaseComponent.interpolate"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"interpolate"},"text":{},"parentId":33471},{"id":33481,"name":"onRender","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":33482,"name":"onRender","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur."}]},"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","id":45,"name":"BaseComponent.onRender"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsItemComponent.Method.onRender","hash":"onRender.onRender"},"text":{"comment":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.\n"},"parentId":33481}],"overwrites":{"type":"reference","id":44,"name":"BaseComponent.onRender"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"onRender"},"text":{},"parentId":33471},{"id":33500,"name":"registerHelpers","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":33501,"name":"registerHelpers","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers)."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":35,"name":"BaseComponent.registerHelpers"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsItemComponent.Method.registerHelpers","hash":"registerHelpers.registerHelpers"},"text":{"comment":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see <a href=\"https://handlebarsjs.com/guide/#custom-helpers\">Custom Helpers</a>.\n"},"parentId":33500}],"inheritedFrom":{"type":"reference","id":34,"name":"BaseComponent.registerHelpers"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"registerHelpers"},"text":{},"parentId":33471},{"id":33502,"name":"render","kind":2048,"kindString":"Method","flags":{"isPublic":true,"isInherited":true},"signatures":[{"id":33503,"name":"render","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Binds "},{"kind":"inline-tag","tag":"@link","text":"contentModel","target":33487},{"kind":"text","text":" to the Handlebars template and renders the resulting HTML content."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":37,"name":"BaseComponent.render"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsItemComponent.Method.render","hash":"render.render"},"text":{"comment":"Binds <a href=\"33487\">contentModel</a> to the Handlebars template and renders the resulting HTML content.\n"},"parentId":33502}],"inheritedFrom":{"type":"reference","id":36,"name":"BaseComponent.render"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"render"},"text":{},"parentId":33471},{"id":33477,"name":"renderContent","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":33478,"name":"renderContent","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"Determines whether the "},{"kind":"inline-tag","tag":"@link","text":"data","target":33484},{"kind":"text","text":" meets the necessary conditions to perform data binding and render content."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Whether the component should be rendered. If "},{"kind":"code","text":"`false`"},{"kind":"text","text":", the component will have empty contents and be set to "},{"kind":"code","text":"`display: none;`"},{"kind":"text","text":"."}]}]},"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","id":39,"name":"BaseComponent.renderContent"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsItemComponent.Method.renderContent","hash":"renderContent.renderContent"},"text":{"comment":"Determines whether the <a href=\"33484\">data</a> meets the necessary conditions to perform data binding and render content.\n<h5>Returns:</h5>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.\n"},"parentId":33477}],"overwrites":{"type":"reference","id":38,"name":"BaseComponent.renderContent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":"renderContent"},"text":{},"parentId":33471}],"groups":[{"title":"Properties","children":[33476,33474,33483,33487,33484,33475,33485]},{"title":"Accessors","children":[33488,33492]},{"title":"Methods","children":[33504,33479,33506,33481,33500,33502,33477]}],"extendedTypes":[{"type":"reference","id":6,"typeArguments":[{"type":"reference","id":40297,"name":"SearchResultsItemComponentConfig"},{"type":"reference","id":41334,"name":"SearchResultsItem"},{"type":"reference","id":41040,"name":"SearchResultsItemComponentModel"}],"name":"BaseComponent"}],"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsItemComponent","hash":""},"text":{"comment":"The Search Results Item component displays information for an individual product or page.\n\n<a href=\"#tag\" id=\"tag\" style=\"color: inherit; text-decoration: none;\">\n <h2>Tag</h2>\n</a>\nThe tag for this component is <code><hawksearch-search-results-item></code>.\n*Note: This component should only be used within the context of the <a href=\"34420\">Search Results List component</a>.\n\n<a href=\"#event-binding-attributes\" id=\"event-binding-attributes\" style=\"color: inherit; text-decoration: none;\">\n <h2>Event-Binding Attributes</h2>\n</a>\n<table>\n<thead>\n<tr>\n<th align=\"left\">Name</th>\n<th align=\"left\">Value</th>\n</tr>\n</thead>\n<tbody><tr>\n<td align=\"left\">hawksearch-image</td>\n<td align=\"left\"></td>\n</tr>\n</tbody></table>\nImage elements with this attribute will have their <code>src</code> value replaced with a placeholder image URL if the image fails to load.\n<table>\n<thead>\n<tr>\n<th align=\"left\">Name</th>\n<th align=\"left\">Value</th>\n</tr>\n</thead>\n<tbody><tr>\n<td align=\"left\">hawksearch-link</td>\n<td align=\"left\"></td>\n</tr>\n</tbody></table>\nAnchor elements with this attribute will be tracked when clicked.\n\n<a href=\"#default-template\" id=\"default-template\" style=\"color: inherit; text-decoration: none;\">\n <h2>Default Template</h2>\n</a>\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n<pre><code><div class=\"search-results-list__item search-results-list__item--{{type}}\">\n {{#if pinned}}\n <span class=\"search-results-list__item__pin\">\n <hawksearch-icon name=\"star\"></hawksearch-icon>\n </span>\n {{/if}}\n {{#if (eq type \"product\")}}\n {{#if (lt salePrice price)}}\n <span class=\"search-results-list__item__sale-indicator\">{{strings.sale}}</span>\n {{/if}}\n <a hawksearch-link href=\"{{url}}\" class=\"search-results-list__item__image\" aria-label=\"{{title}}\">\n <img hawksearch-image src=\"{{imageUrl}}\" alt=\"\" />\n </a>\n <div class=\"search-results-list__item__title\">\n <a hawksearch-link href=\"{{url}}\">{{title}}</a>\n </div>\n {{#if rating}}\n <hawksearch-rating rating=\"{{rating}}\"></hawksearch-rating>\n {{/if}}\n {{#unless (eq price undefined)}}\n <div class=\"search-results-list__item__price\" itemprop=\"offers\" itemtype=\"http://schema.org/Offer\" itemscope>\n {{#if (lt salePrice price)}}\n <span class=\"search-results-list__item__price__original\">{{currency price}}</span>\n <span class=\"search-results-list__item__price__current\" itemprop=\"price\">{{currency salePrice}}</span>\n {{else}}\n <span class=\"search-results-list__item__price-__current\" itemprop=\"price\">{{currency price}}</span>\n {{/if}}\n </div>\n {{/unless}}\n <hawksearch-variant-selector></hawksearch-variant-selector>\n {{else}}\n <div class=\"row\">\n {{#if imageUrl}}\n <div class=\"column column--12 column-sm--4\">\n <a hawksearch-link href=\"{{url}}\">\n <img hawksearch-image src=\"{{imageUrl}}\" alt=\"\" />\n </a>\n </div>\n {{/if}}\n <div class=\"column column--12 column-sm--8 flex-align-self-sm-center\">\n <div class=\"search-results-list__item__title\">\n <a hawksearch-link href=\"{{url}}\">{{title}}</a>\n </div>\n {{#if description}}\n <p>{{description}}</p>\n {{/if}}\n </div>\n </div>\n {{/if}}\n</div>\n</code></pre>\n"},"parentId":1,"hierarchy":[{"name":"BaseComponent<SearchResultsItemComponentConfig, SearchResultsItem, SearchResultsItemComponentModel>","linkId":"6","children":[{"name":"SearchResultsItemComponent","isTarget":true,"linkId":"33471"}]}]}

package/docs/v5.2.0/data/Components.Class.SearchResultsListComponent.json DELETED Viewed

@@ -1 +0,0 @@

- {"id":34420,"name":"SearchResultsListComponent","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"The Search Results List component is a wrapper around a group of "},{"kind":"inline-tag","tag":"@link","text":"Search Results Item","target":33471},{"kind":"text","text":" components.\n\n## Tag\nThe tag for this component is "},{"kind":"code","text":"`<hawksearch-search-results-list>`"},{"kind":"text","text":".\n\n## Default Template\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n"},{"kind":"code","text":"```\n<div class=\"row search-results-list\">\n {{#each items}}\n {{#if (eq type \"content\")}}\n <div class=\"column column--12\">\n <hawksearch-search-results-item></hawksearch-search-results-item>\n </div>\n {{else}}\n <div class=\"column column--12 column-sm--6 column-lg--4\">\n <hawksearch-search-results-item></hawksearch-search-results-item>\n </div>\n {{/if}}\n {{/each}}\n</div>\n```"}]},"children":[{"id":34425,"name":"bindFromEvent","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true","overwrites":{"type":"reference","name":"BaseComponent.bindFromEvent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"bindFromEvent"},"text":{},"parentId":34420},{"id":34423,"name":"componentName","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","id":40340,"name":"HawkSearchComponents"}},"defaultValue":"'search-results-list'","overwrites":{"type":"reference","name":"BaseComponent.componentName"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"componentName"},"text":{},"parentId":34420},{"id":34432,"name":"configOverride","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional instance-level configuration to override the global configuration"}]},"type":{"type":"reference","id":40303,"name":"SearchResultsListComponentConfig"},"inheritedFrom":{"type":"reference","id":12,"name":"BaseComponent.configOverride"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"configOverride"},"text":{"comment":"Optional instance-level configuration to override the global configuration\n"},"parentId":34420},{"id":34436,"name":"contentModel","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the Handlebars template."}]},"type":{"type":"reference","id":41060,"name":"SearchResultsListComponentModel"},"inheritedFrom":{"type":"reference","id":16,"name":"BaseComponent.contentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"contentModel"},"text":{"comment":"The data bound to the Handlebars template.\n"},"parentId":34420},{"id":34433,"name":"data","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the component."}]},"type":{"type":"array","elementType":{"type":"reference","id":41334,"name":"SearchResultsItem"}},"inheritedFrom":{"type":"reference","id":13,"name":"BaseComponent.data"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"data"},"text":{"comment":"The data bound to the component.\n"},"parentId":34420},{"id":34424,"name":"defaultHtml","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"any"},"defaultValue":"defaultHtml","overwrites":{"type":"reference","name":"BaseComponent.defaultHtml"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"defaultHtml"},"text":{},"parentId":34420},{"id":34434,"name":"handlebars","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The Handlebars reference shared by all HawkSearch components."}]},"type":{"type":"query","queryType":{"type":"reference","name":"Handlebars","qualifiedName":"Handlebars","package":"handlebars"}},"defaultValue":"HawkSearch.handlebars","inheritedFrom":{"type":"reference","id":14,"name":"BaseComponent.handlebars"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"handlebars"},"text":{"comment":"The Handlebars reference shared by all HawkSearch components.\n"},"parentId":34420},{"id":34437,"name":"configuration","kind":262144,"kindString":"Accessor","flags":{"isProtected":true,"isInherited":true},"getSignature":{"id":34438,"name":"configuration","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The optional configuration object for this component."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reference","name":"TConfig"}]},"inheritedFrom":{"type":"reference","name":"BaseComponent.configuration"},"text":{"comment":"The optional configuration object for this component.\n"}},"inheritedFrom":{"type":"reference","id":20,"name":"BaseComponent.configuration"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"configuration"},"text":{},"parentId":34420},{"id":34441,"name":"rootElement","kind":262144,"kindString":"Accessor","flags":{"isPublic":true,"isInherited":true},"getSignature":{"id":34442,"name":"rootElement","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The root element which should be used for querying any child elements. This resolves to "},{"kind":"code","text":"`this.shadowRoot`"},{"kind":"text","text":" if the Shadow DOM is enabled, otherwise "},{"kind":"code","text":"`this`"},{"kind":"text","text":"."}]},"type":{"type":"reference","name":"ParentNode","qualifiedName":"ParentNode","package":"typescript"},"inheritedFrom":{"type":"reference","name":"BaseComponent.rootElement"},"text":{"comment":"The root element which should be used for querying any child elements. This resolves to <code>this.shadowRoot</code> if the Shadow DOM is enabled, otherwise <code>this</code>.\n"}},"inheritedFrom":{"type":"reference","id":24,"name":"BaseComponent.rootElement"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"rootElement"},"text":{},"parentId":34420},{"id":34430,"name":"bindChildElements","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":34431,"name":"bindChildElements","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called to bind any child components."}]},"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","id":43,"name":"BaseComponent.bindChildElements"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsListComponent.Method.bindChildElements","hash":"bindChildElements.bindChildElements"},"text":{"comment":"After the component is rendered, this method is called to bind any child components.\n"},"parentId":34430}],"overwrites":{"type":"reference","id":42,"name":"BaseComponent.bindChildElements"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"bindChildElements"},"text":{},"parentId":34420},{"id":34428,"name":"getContentModel","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":34429,"name":"getContentModel","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"type":{"type":"reference","id":41060,"name":"SearchResultsListComponentModel"},"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsListComponent.Method.getContentModel","hash":"getContentModel.getContentModel"},"text":{},"parentId":34428}],"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"getContentModel"},"text":{},"parentId":34420},{"id":34455,"name":"interpolate","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":34456,"name":"interpolate","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Replaces placeholders in a given string with values from a data object."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The "},{"kind":"code","text":"`template`"},{"kind":"text","text":" string with all placeholders replaced by the values specified in "},{"kind":"code","text":"`values`"},{"kind":"text","text":"."}]}]},"parameters":[{"id":34457,"name":"template","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The template string."}]},"type":{"type":"intrinsic","name":"string"},"text":{"comment":"The template string.\n"}},{"id":34458,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The object containing properties which will be bound to "},{"kind":"code","text":"`template`"},{"kind":"text","text":"."}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","qualifiedName":"Record","package":"typescript"},"text":{"comment":"The object containing properties which will be bound to <code>template</code>.\n"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":49,"name":"BaseComponent.interpolate"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsListComponent.Method.interpolate","hash":"interpolate.interpolate"},"text":{"comment":"Replaces placeholders in a given string with values from a data object.\n<h5>Returns:</h5>The <code>template</code> string with all placeholders replaced by the values specified in <code>values</code>.\n"},"parentId":34455}],"inheritedFrom":{"type":"reference","id":48,"name":"BaseComponent.interpolate"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"interpolate"},"text":{},"parentId":34420},{"id":34453,"name":"onRender","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":34454,"name":"onRender","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":45,"name":"BaseComponent.onRender"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsListComponent.Method.onRender","hash":"onRender.onRender"},"text":{"comment":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.\n"},"parentId":34453}],"inheritedFrom":{"type":"reference","id":44,"name":"BaseComponent.onRender"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"onRender"},"text":{},"parentId":34420},{"id":34449,"name":"registerHelpers","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":34450,"name":"registerHelpers","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers)."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":35,"name":"BaseComponent.registerHelpers"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsListComponent.Method.registerHelpers","hash":"registerHelpers.registerHelpers"},"text":{"comment":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see <a href=\"https://handlebarsjs.com/guide/#custom-helpers\">Custom Helpers</a>.\n"},"parentId":34449}],"inheritedFrom":{"type":"reference","id":34,"name":"BaseComponent.registerHelpers"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"registerHelpers"},"text":{},"parentId":34420},{"id":34451,"name":"render","kind":2048,"kindString":"Method","flags":{"isPublic":true,"isInherited":true},"signatures":[{"id":34452,"name":"render","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Binds "},{"kind":"inline-tag","tag":"@link","text":"contentModel","target":34436},{"kind":"text","text":" to the Handlebars template and renders the resulting HTML content."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":37,"name":"BaseComponent.render"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsListComponent.Method.render","hash":"render.render"},"text":{"comment":"Binds <a href=\"34436\">contentModel</a> to the Handlebars template and renders the resulting HTML content.\n"},"parentId":34451}],"inheritedFrom":{"type":"reference","id":36,"name":"BaseComponent.render"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"render"},"text":{},"parentId":34420},{"id":34426,"name":"renderContent","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":34427,"name":"renderContent","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"Determines whether the "},{"kind":"inline-tag","tag":"@link","text":"data","target":34433},{"kind":"text","text":" meets the necessary conditions to perform data binding and render content."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Whether the component should be rendered. If "},{"kind":"code","text":"`false`"},{"kind":"text","text":", the component will have empty contents and be set to "},{"kind":"code","text":"`display: none;`"},{"kind":"text","text":"."}]}]},"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","id":39,"name":"BaseComponent.renderContent"},"is":{"declaration":false},"location":{"query":"Components.SearchResultsListComponent.Method.renderContent","hash":"renderContent.renderContent"},"text":{"comment":"Determines whether the <a href=\"34433\">data</a> meets the necessary conditions to perform data binding and render content.\n<h5>Returns:</h5>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.\n"},"parentId":34426}],"overwrites":{"type":"reference","id":38,"name":"BaseComponent.renderContent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":"renderContent"},"text":{},"parentId":34420}],"groups":[{"title":"Properties","children":[34425,34423,34432,34436,34433,34424,34434]},{"title":"Accessors","children":[34437,34441]},{"title":"Methods","children":[34430,34428,34455,34453,34449,34451,34426]}],"extendedTypes":[{"type":"reference","id":6,"typeArguments":[{"type":"reference","id":40303,"name":"SearchResultsListComponentConfig"},{"type":"array","elementType":{"type":"reference","id":41334,"name":"SearchResultsItem"}},{"type":"reference","id":41060,"name":"SearchResultsListComponentModel"}],"name":"BaseComponent"}],"is":{"declaration":true},"location":{"query":"Components.Class.SearchResultsListComponent","hash":""},"text":{"comment":"The Search Results List component is a wrapper around a group of <a href=\"33471\">Search Results Item</a> components.\n\n<a href=\"#tag\" id=\"tag\" style=\"color: inherit; text-decoration: none;\">\n <h2>Tag</h2>\n</a>\nThe tag for this component is <code><hawksearch-search-results-list></code>.\n\n<a href=\"#default-template\" id=\"default-template\" style=\"color: inherit; text-decoration: none;\">\n <h2>Default Template</h2>\n</a>\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n<pre><code><div class=\"row search-results-list\">\n {{#each items}}\n {{#if (eq type \"content\")}}\n <div class=\"column column--12\">\n <hawksearch-search-results-item></hawksearch-search-results-item>\n </div>\n {{else}}\n <div class=\"column column--12 column-sm--6 column-lg--4\">\n <hawksearch-search-results-item></hawksearch-search-results-item>\n </div>\n {{/if}}\n {{/each}}\n</div>\n</code></pre>\n"},"parentId":1,"hierarchy":[{"name":"BaseComponent<SearchResultsListComponentConfig, SearchResultsItem[], SearchResultsListComponentModel>","linkId":"6","children":[{"name":"SearchResultsListComponent","isTarget":true,"linkId":"34420"}]}]}

package/docs/v5.2.0/data/Components.Class.SearchWithinFacetComponent.json DELETED Viewed

@@ -1 +0,0 @@

- {"id":24898,"name":"SearchWithinFacetComponent","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"The Search Within Facet component allows the user to enter keywords to further refine the list of search results.\n\n## Tag\nThe tag for this component is "},{"kind":"code","text":"`<hawksearch-search-within-facet>`"},{"kind":"text","text":".\n\n## Event-Binding Attributes\n| Name | Value |\n| :- | :- |\n| hawksearch-input | |\n\nWhen the value of an input element with this attribute changes, that value will be used to refine the list of search results.\n\n## Default Template\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n"},{"kind":"code","text":"```\n<div class=\"search-within-facet\">\n <input type=\"text\" hawksearch-input value=\"{{value}}\" class=\"search-within-facet__input\" aria-label=\"{{strings.label}}\" />\n</div>\n```"}]},"children":[{"id":24909,"name":"bindFromEvent","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isInherited":true},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false","inheritedFrom":{"type":"reference","id":16316,"name":"BaseFacetComponent.bindFromEvent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"bindFromEvent"},"text":{},"parentId":24898},{"id":24901,"name":"componentName","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","id":40340,"name":"HawkSearchComponents"}},"defaultValue":"'search-within-facet'","overwrites":{"type":"reference","name":"BaseFacetComponent.componentName"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"componentName"},"text":{},"parentId":24898},{"id":24911,"name":"configOverride","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional instance-level configuration to override the global configuration"}]},"type":{"type":"reference","id":40306,"name":"SearchWithinFacetComponentConfig"},"inheritedFrom":{"type":"reference","id":16320,"name":"BaseFacetComponent.configOverride"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"configOverride"},"text":{"comment":"Optional instance-level configuration to override the global configuration\n"},"parentId":24898},{"id":24915,"name":"contentModel","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the Handlebars template."}]},"type":{"type":"reference","id":41062,"name":"SearchWithinFacetComponentModel"},"inheritedFrom":{"type":"reference","id":16324,"name":"BaseFacetComponent.contentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"contentModel"},"text":{"comment":"The data bound to the Handlebars template.\n"},"parentId":24898},{"id":24912,"name":"data","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the component."}]},"type":{"type":"reference","id":41270,"name":"Facet"},"inheritedFrom":{"type":"reference","id":16321,"name":"BaseFacetComponent.data"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"data"},"text":{"comment":"The data bound to the component.\n"},"parentId":24898},{"id":24902,"name":"defaultHtml","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"any"},"defaultValue":"defaultHtml","overwrites":{"type":"reference","name":"BaseFacetComponent.defaultHtml"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"defaultHtml"},"text":{},"parentId":24898},{"id":24913,"name":"handlebars","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The Handlebars reference shared by all HawkSearch components."}]},"type":{"type":"query","queryType":{"type":"reference","name":"Handlebars","qualifiedName":"Handlebars","package":"handlebars"}},"defaultValue":"HawkSearch.handlebars","inheritedFrom":{"type":"reference","id":16322,"name":"BaseFacetComponent.handlebars"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"handlebars"},"text":{"comment":"The Handlebars reference shared by all HawkSearch components.\n"},"parentId":24898},{"id":24910,"name":"state","kind":1024,"kindString":"Property","flags":{"isInherited":true},"type":{"type":"reference","id":41216,"name":"FacetState"},"inheritedFrom":{"type":"reference","id":16317,"name":"BaseFacetComponent.state"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"state"},"text":{},"parentId":24898},{"id":24916,"name":"configuration","kind":262144,"kindString":"Accessor","flags":{"isProtected":true,"isInherited":true},"getSignature":{"id":24917,"name":"configuration","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The optional configuration object for this component."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reference","name":"TConfig"}]},"inheritedFrom":{"type":"reference","name":"BaseFacetComponent.configuration"},"text":{"comment":"The optional configuration object for this component.\n"}},"inheritedFrom":{"type":"reference","id":16327,"name":"BaseFacetComponent.configuration"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"configuration"},"text":{},"parentId":24898},{"id":24920,"name":"rootElement","kind":262144,"kindString":"Accessor","flags":{"isPublic":true,"isInherited":true},"getSignature":{"id":24921,"name":"rootElement","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The root element which should be used for querying any child elements. This resolves to "},{"kind":"code","text":"`this.shadowRoot`"},{"kind":"text","text":" if the Shadow DOM is enabled, otherwise "},{"kind":"code","text":"`this`"},{"kind":"text","text":"."}]},"type":{"type":"reference","name":"ParentNode","qualifiedName":"ParentNode","package":"typescript"},"inheritedFrom":{"type":"reference","name":"BaseFacetComponent.rootElement"},"text":{"comment":"The root element which should be used for querying any child elements. This resolves to <code>this.shadowRoot</code> if the Shadow DOM is enabled, otherwise <code>this</code>.\n"}},"inheritedFrom":{"type":"reference","id":16331,"name":"BaseFacetComponent.rootElement"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"rootElement"},"text":{},"parentId":24898},{"id":24932,"name":"bindChildElements","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":24933,"name":"bindChildElements","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called to bind any child components."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":16348,"name":"BaseFacetComponent.bindChildElements"},"is":{"declaration":false},"location":{"query":"Components.SearchWithinFacetComponent.Method.bindChildElements","hash":"bindChildElements.bindChildElements"},"text":{"comment":"After the component is rendered, this method is called to bind any child components.\n"},"parentId":24932}],"inheritedFrom":{"type":"reference","id":16347,"name":"BaseFacetComponent.bindChildElements"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"bindChildElements"},"text":{},"parentId":24898},{"id":24905,"name":"getContentModel","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":24906,"name":"getContentModel","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"type":{"type":"reference","id":41062,"name":"SearchWithinFacetComponentModel"},"overwrites":{"type":"reference","name":"BaseFacetComponent.getContentModel"},"is":{"declaration":false},"location":{"query":"Components.SearchWithinFacetComponent.Method.getContentModel","hash":"getContentModel.getContentModel"},"text":{},"parentId":24905}],"overwrites":{"type":"reference","name":"BaseFacetComponent.getContentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"getContentModel"},"text":{},"parentId":24898},{"id":24934,"name":"interpolate","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":24935,"name":"interpolate","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Replaces placeholders in a given string with values from a data object."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The "},{"kind":"code","text":"`template`"},{"kind":"text","text":" string with all placeholders replaced by the values specified in "},{"kind":"code","text":"`values`"},{"kind":"text","text":"."}]}]},"parameters":[{"id":24936,"name":"template","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The template string."}]},"type":{"type":"intrinsic","name":"string"},"text":{"comment":"The template string.\n"}},{"id":24937,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The object containing properties which will be bound to "},{"kind":"code","text":"`template`"},{"kind":"text","text":"."}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","qualifiedName":"Record","package":"typescript"},"text":{"comment":"The object containing properties which will be bound to <code>template</code>.\n"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":16350,"name":"BaseFacetComponent.interpolate"},"is":{"declaration":false},"location":{"query":"Components.SearchWithinFacetComponent.Method.interpolate","hash":"interpolate.interpolate"},"text":{"comment":"Replaces placeholders in a given string with values from a data object.\n<h5>Returns:</h5>The <code>template</code> string with all placeholders replaced by the values specified in <code>values</code>.\n"},"parentId":24934}],"inheritedFrom":{"type":"reference","id":16349,"name":"BaseFacetComponent.interpolate"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"interpolate"},"text":{},"parentId":24898},{"id":24907,"name":"onRender","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":24908,"name":"onRender","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur."}]},"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","id":16319,"name":"BaseFacetComponent.onRender"},"is":{"declaration":false},"location":{"query":"Components.SearchWithinFacetComponent.Method.onRender","hash":"onRender.onRender"},"text":{"comment":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.\n"},"parentId":24907}],"overwrites":{"type":"reference","id":16318,"name":"BaseFacetComponent.onRender"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"onRender"},"text":{},"parentId":24898},{"id":24928,"name":"registerHelpers","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":24929,"name":"registerHelpers","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers)."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":16340,"name":"BaseFacetComponent.registerHelpers"},"is":{"declaration":false},"location":{"query":"Components.SearchWithinFacetComponent.Method.registerHelpers","hash":"registerHelpers.registerHelpers"},"text":{"comment":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see <a href=\"https://handlebarsjs.com/guide/#custom-helpers\">Custom Helpers</a>.\n"},"parentId":24928}],"inheritedFrom":{"type":"reference","id":16339,"name":"BaseFacetComponent.registerHelpers"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"registerHelpers"},"text":{},"parentId":24898},{"id":24930,"name":"render","kind":2048,"kindString":"Method","flags":{"isPublic":true,"isInherited":true},"signatures":[{"id":24931,"name":"render","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Binds "},{"kind":"inline-tag","tag":"@link","text":"contentModel","target":24915},{"kind":"text","text":" to the Handlebars template and renders the resulting HTML content."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":16342,"name":"BaseFacetComponent.render"},"is":{"declaration":false},"location":{"query":"Components.SearchWithinFacetComponent.Method.render","hash":"render.render"},"text":{"comment":"Binds <a href=\"24915\">contentModel</a> to the Handlebars template and renders the resulting HTML content.\n"},"parentId":24930}],"inheritedFrom":{"type":"reference","id":16341,"name":"BaseFacetComponent.render"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"render"},"text":{},"parentId":24898},{"id":24903,"name":"renderContent","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":24904,"name":"renderContent","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"Determines whether the "},{"kind":"inline-tag","tag":"@link","text":"data","target":24912},{"kind":"text","text":" meets the necessary conditions to perform data binding and render content."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Whether the component should be rendered. If "},{"kind":"code","text":"`false`"},{"kind":"text","text":", the component will have empty contents and be set to "},{"kind":"code","text":"`display: none;`"},{"kind":"text","text":"."}]}]},"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","id":16344,"name":"BaseFacetComponent.renderContent"},"is":{"declaration":false},"location":{"query":"Components.SearchWithinFacetComponent.Method.renderContent","hash":"renderContent.renderContent"},"text":{"comment":"Determines whether the <a href=\"24912\">data</a> meets the necessary conditions to perform data binding and render content.\n<h5>Returns:</h5>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.\n"},"parentId":24903}],"overwrites":{"type":"reference","id":16343,"name":"BaseFacetComponent.renderContent"},"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":"renderContent"},"text":{},"parentId":24898}],"groups":[{"title":"Properties","children":[24909,24901,24911,24915,24912,24902,24913,24910]},{"title":"Accessors","children":[24916,24920]},{"title":"Methods","children":[24932,24905,24934,24907,24928,24930,24903]}],"extendedTypes":[{"type":"reference","id":16311,"typeArguments":[{"type":"reference","id":40306,"name":"SearchWithinFacetComponentConfig"},{"type":"reference","id":41062,"name":"SearchWithinFacetComponentModel"}],"name":"BaseFacetComponent"}],"is":{"declaration":true},"location":{"query":"Components.Class.SearchWithinFacetComponent","hash":""},"text":{"comment":"The Search Within Facet component allows the user to enter keywords to further refine the list of search results.\n\n<a href=\"#tag\" id=\"tag\" style=\"color: inherit; text-decoration: none;\">\n <h2>Tag</h2>\n</a>\nThe tag for this component is <code><hawksearch-search-within-facet></code>.\n\n<a href=\"#event-binding-attributes\" id=\"event-binding-attributes\" style=\"color: inherit; text-decoration: none;\">\n <h2>Event-Binding Attributes</h2>\n</a>\n<table>\n<thead>\n<tr>\n<th align=\"left\">Name</th>\n<th align=\"left\">Value</th>\n</tr>\n</thead>\n<tbody><tr>\n<td align=\"left\">hawksearch-input</td>\n<td align=\"left\"></td>\n</tr>\n</tbody></table>\nWhen the value of an input element with this attribute changes, that value will be used to refine the list of search results.\n\n<a href=\"#default-template\" id=\"default-template\" style=\"color: inherit; text-decoration: none;\">\n <h2>Default Template</h2>\n</a>\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n<pre><code><div class=\"search-within-facet\">\n <input type=\"text\" hawksearch-input value=\"{{value}}\" class=\"search-within-facet__input\" aria-label=\"{{strings.label}}\" />\n</div>\n</code></pre>\n"},"parentId":1,"hierarchy":[{"name":"BaseFacetComponent<SearchWithinFacetComponentConfig, SearchWithinFacetComponentModel>","linkId":"16311","children":[{"name":"SearchWithinFacetComponent","isTarget":true,"linkId":"24898"}]}]}

package/docs/v5.2.0/data/Components.Class.SelectedFacetsComponent.json DELETED Viewed

@@ -1 +0,0 @@

- {"id":36322,"name":"SelectedFacetsComponent","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"The Selected Facets component displays a list of facets that have been selected by the user.\n\n## Tag\nThe tag for this component is "},{"kind":"code","text":"`<hawksearch-selected-facets>`"},{"kind":"text","text":".\n\n## Event-Binding Attributes\n| Name | Value |\n| :- | :- |\n| hawksearch-facet-field | "},{"kind":"code","text":"`string`"},{"kind":"text","text":" |\n| hawksearch-facet-value | "},{"kind":"code","text":"`string`"},{"kind":"text","text":" |\n\nWhen an element with both of these attributes is clicked, that facet selection will be removed and the search results will be updated.\n\n## Default Template\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n"},{"kind":"code","text":"```\n<div class=\"flex-gap flex-gap--xs selected-facets\">\n {{#each selections}}\n \n {{title}}\n {{selectionTitle}}\n <a\n hawksearch-facet-field=\"{{field}}\"\n hawksearch-facet-value=\"{{selectionValue}}\"\n class=\"selected-facets__item__remove\"\n title=\"{{@root.strings.remove}}\"\n >\n <hawksearch-icon name=\"cross\" size=\"0.9em\"></hawksearch-icon>\n </a>\n \n {{/each}}\n</div>\n```"}]},"children":[{"id":36327,"name":"bindFromEvent","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true","overwrites":{"type":"reference","name":"BaseComponent.bindFromEvent"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"bindFromEvent"},"text":{},"parentId":36322},{"id":36325,"name":"componentName","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","id":40340,"name":"HawkSearchComponents"}},"defaultValue":"'selected-facets'","overwrites":{"type":"reference","name":"BaseComponent.componentName"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"componentName"},"text":{},"parentId":36322},{"id":36334,"name":"configOverride","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional instance-level configuration to override the global configuration"}]},"type":{"type":"reference","id":40312,"name":"SelectedFacetsComponentConfig"},"inheritedFrom":{"type":"reference","id":12,"name":"BaseComponent.configOverride"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"configOverride"},"text":{"comment":"Optional instance-level configuration to override the global configuration\n"},"parentId":36322},{"id":36338,"name":"contentModel","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the Handlebars template."}]},"type":{"type":"reference","id":41067,"name":"SelectedFacetsComponentModel"},"inheritedFrom":{"type":"reference","id":16,"name":"BaseComponent.contentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"contentModel"},"text":{"comment":"The data bound to the Handlebars template.\n"},"parentId":36322},{"id":36335,"name":"data","kind":1024,"kindString":"Property","flags":{"isOptional":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The data bound to the component."}]},"type":{"type":"array","elementType":{"type":"reference","id":41232,"name":"SelectedFacet"}},"inheritedFrom":{"type":"reference","id":13,"name":"BaseComponent.data"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"data"},"text":{"comment":"The data bound to the component.\n"},"parentId":36322},{"id":36326,"name":"defaultHtml","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isOverride":true},"type":{"type":"intrinsic","name":"any"},"defaultValue":"defaultHtml","overwrites":{"type":"reference","name":"BaseComponent.defaultHtml"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"defaultHtml"},"text":{},"parentId":36322},{"id":36336,"name":"handlebars","kind":1024,"kindString":"Property","flags":{"isProtected":true,"isInherited":true},"comment":{"summary":[{"kind":"text","text":"The Handlebars reference shared by all HawkSearch components."}]},"type":{"type":"query","queryType":{"type":"reference","name":"Handlebars","qualifiedName":"Handlebars","package":"handlebars"}},"defaultValue":"HawkSearch.handlebars","inheritedFrom":{"type":"reference","id":14,"name":"BaseComponent.handlebars"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"handlebars"},"text":{"comment":"The Handlebars reference shared by all HawkSearch components.\n"},"parentId":36322},{"id":36339,"name":"configuration","kind":262144,"kindString":"Accessor","flags":{"isProtected":true,"isInherited":true},"getSignature":{"id":36340,"name":"configuration","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The optional configuration object for this component."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reference","name":"TConfig"}]},"inheritedFrom":{"type":"reference","name":"BaseComponent.configuration"},"text":{"comment":"The optional configuration object for this component.\n"}},"inheritedFrom":{"type":"reference","id":20,"name":"BaseComponent.configuration"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"configuration"},"text":{},"parentId":36322},{"id":36343,"name":"rootElement","kind":262144,"kindString":"Accessor","flags":{"isPublic":true,"isInherited":true},"getSignature":{"id":36344,"name":"rootElement","kind":524288,"kindString":"Get signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The root element which should be used for querying any child elements. This resolves to "},{"kind":"code","text":"`this.shadowRoot`"},{"kind":"text","text":" if the Shadow DOM is enabled, otherwise "},{"kind":"code","text":"`this`"},{"kind":"text","text":"."}]},"type":{"type":"reference","name":"ParentNode","qualifiedName":"ParentNode","package":"typescript"},"inheritedFrom":{"type":"reference","name":"BaseComponent.rootElement"},"text":{"comment":"The root element which should be used for querying any child elements. This resolves to <code>this.shadowRoot</code> if the Shadow DOM is enabled, otherwise <code>this</code>.\n"}},"inheritedFrom":{"type":"reference","id":24,"name":"BaseComponent.rootElement"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"rootElement"},"text":{},"parentId":36322},{"id":36355,"name":"bindChildElements","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":36356,"name":"bindChildElements","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called to bind any child components."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":43,"name":"BaseComponent.bindChildElements"},"is":{"declaration":false},"location":{"query":"Components.SelectedFacetsComponent.Method.bindChildElements","hash":"bindChildElements.bindChildElements"},"text":{"comment":"After the component is rendered, this method is called to bind any child components.\n"},"parentId":36355}],"inheritedFrom":{"type":"reference","id":42,"name":"BaseComponent.bindChildElements"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"bindChildElements"},"text":{},"parentId":36322},{"id":36330,"name":"getContentModel","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":36331,"name":"getContentModel","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"type":{"type":"reference","id":41067,"name":"SelectedFacetsComponentModel"},"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":false},"location":{"query":"Components.SelectedFacetsComponent.Method.getContentModel","hash":"getContentModel.getContentModel"},"text":{},"parentId":36330}],"overwrites":{"type":"reference","name":"BaseComponent.getContentModel"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"getContentModel"},"text":{},"parentId":36322},{"id":36357,"name":"interpolate","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":36358,"name":"interpolate","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Replaces placeholders in a given string with values from a data object."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The "},{"kind":"code","text":"`template`"},{"kind":"text","text":" string with all placeholders replaced by the values specified in "},{"kind":"code","text":"`values`"},{"kind":"text","text":"."}]}]},"parameters":[{"id":36359,"name":"template","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The template string."}]},"type":{"type":"intrinsic","name":"string"},"text":{"comment":"The template string.\n"}},{"id":36360,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The object containing properties which will be bound to "},{"kind":"code","text":"`template`"},{"kind":"text","text":"."}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","qualifiedName":"Record","package":"typescript"},"text":{"comment":"The object containing properties which will be bound to <code>template</code>.\n"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":49,"name":"BaseComponent.interpolate"},"is":{"declaration":false},"location":{"query":"Components.SelectedFacetsComponent.Method.interpolate","hash":"interpolate.interpolate"},"text":{"comment":"Replaces placeholders in a given string with values from a data object.\n<h5>Returns:</h5>The <code>template</code> string with all placeholders replaced by the values specified in <code>values</code>.\n"},"parentId":36357}],"inheritedFrom":{"type":"reference","id":48,"name":"BaseComponent.interpolate"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"interpolate"},"text":{},"parentId":36322},{"id":36332,"name":"onRender","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":36333,"name":"onRender","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur."}]},"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","id":45,"name":"BaseComponent.onRender"},"is":{"declaration":false},"location":{"query":"Components.SelectedFacetsComponent.Method.onRender","hash":"onRender.onRender"},"text":{"comment":"After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.\n"},"parentId":36332}],"overwrites":{"type":"reference","id":44,"name":"BaseComponent.onRender"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"onRender"},"text":{},"parentId":36322},{"id":36351,"name":"registerHelpers","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isInherited":true},"signatures":[{"id":36352,"name":"registerHelpers","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers)."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":35,"name":"BaseComponent.registerHelpers"},"is":{"declaration":false},"location":{"query":"Components.SelectedFacetsComponent.Method.registerHelpers","hash":"registerHelpers.registerHelpers"},"text":{"comment":"Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see <a href=\"https://handlebarsjs.com/guide/#custom-helpers\">Custom Helpers</a>.\n"},"parentId":36351}],"inheritedFrom":{"type":"reference","id":34,"name":"BaseComponent.registerHelpers"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"registerHelpers"},"text":{},"parentId":36322},{"id":36353,"name":"render","kind":2048,"kindString":"Method","flags":{"isPublic":true,"isInherited":true},"signatures":[{"id":36354,"name":"render","kind":4096,"kindString":"Call signature","flags":{"isInherited":true},"comment":{"summary":[{"kind":"text","text":"Binds "},{"kind":"inline-tag","tag":"@link","text":"contentModel","target":36338},{"kind":"text","text":" to the Handlebars template and renders the resulting HTML content."}]},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","id":37,"name":"BaseComponent.render"},"is":{"declaration":false},"location":{"query":"Components.SelectedFacetsComponent.Method.render","hash":"render.render"},"text":{"comment":"Binds <a href=\"36338\">contentModel</a> to the Handlebars template and renders the resulting HTML content.\n"},"parentId":36353}],"inheritedFrom":{"type":"reference","id":36,"name":"BaseComponent.render"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"render"},"text":{},"parentId":36322},{"id":36328,"name":"renderContent","kind":2048,"kindString":"Method","flags":{"isProtected":true,"isOverride":true},"signatures":[{"id":36329,"name":"renderContent","kind":4096,"kindString":"Call signature","flags":{"isOverride":true},"comment":{"summary":[{"kind":"text","text":"Determines whether the "},{"kind":"inline-tag","tag":"@link","text":"data","target":36335},{"kind":"text","text":" meets the necessary conditions to perform data binding and render content."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"Whether the component should be rendered. If "},{"kind":"code","text":"`false`"},{"kind":"text","text":", the component will have empty contents and be set to "},{"kind":"code","text":"`display: none;`"},{"kind":"text","text":"."}]}]},"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","id":39,"name":"BaseComponent.renderContent"},"is":{"declaration":false},"location":{"query":"Components.SelectedFacetsComponent.Method.renderContent","hash":"renderContent.renderContent"},"text":{"comment":"Determines whether the <a href=\"36335\">data</a> meets the necessary conditions to perform data binding and render content.\n<h5>Returns:</h5>Whether the component should be rendered. If <code>false</code>, the component will have empty contents and be set to <code>display: none;</code>.\n"},"parentId":36328}],"overwrites":{"type":"reference","id":38,"name":"BaseComponent.renderContent"},"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":"renderContent"},"text":{},"parentId":36322}],"groups":[{"title":"Properties","children":[36327,36325,36334,36338,36335,36326,36336]},{"title":"Accessors","children":[36339,36343]},{"title":"Methods","children":[36355,36330,36357,36332,36351,36353,36328]}],"extendedTypes":[{"type":"reference","id":6,"typeArguments":[{"type":"reference","id":40312,"name":"SelectedFacetsComponentConfig"},{"type":"array","elementType":{"type":"reference","id":41232,"name":"SelectedFacet"}},{"type":"reference","id":41067,"name":"SelectedFacetsComponentModel"}],"name":"BaseComponent"}],"is":{"declaration":true},"location":{"query":"Components.Class.SelectedFacetsComponent","hash":""},"text":{"comment":"The Selected Facets component displays a list of facets that have been selected by the user.\n\n<a href=\"#tag\" id=\"tag\" style=\"color: inherit; text-decoration: none;\">\n <h2>Tag</h2>\n</a>\nThe tag for this component is <code><hawksearch-selected-facets></code>.\n\n<a href=\"#event-binding-attributes\" id=\"event-binding-attributes\" style=\"color: inherit; text-decoration: none;\">\n <h2>Event-Binding Attributes</h2>\n</a>\n<table>\n<thead>\n<tr>\n<th align=\"left\">Name</th>\n<th align=\"left\">Value</th>\n</tr>\n</thead>\n<tbody><tr>\n<td align=\"left\">hawksearch-facet-field</td>\n<td align=\"left\"><code>string</code></td>\n</tr>\n<tr>\n<td align=\"left\">hawksearch-facet-value</td>\n<td align=\"left\"><code>string</code></td>\n</tr>\n</tbody></table>\nWhen an element with both of these attributes is clicked, that facet selection will be removed and the search results will be updated.\n\n<a href=\"#default-template\" id=\"default-template\" style=\"color: inherit; text-decoration: none;\">\n <h2>Default Template</h2>\n</a>\nThe following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.\n<pre><code><div class=\"flex-gap flex-gap--xs selected-facets\">\n {{#each selections}}\n <span class=\"selected-facets__item\">\n <span class=\"selected-facets__item__field\">{{title}}</span>\n <span class=\"selected-facets__item__value{{attribute ' selected-facets__item__value--excluded' excluded}}\">{{selectionTitle}}</span>\n <a\n hawksearch-facet-field=\"{{field}}\"\n hawksearch-facet-value=\"{{selectionValue}}\"\n class=\"selected-facets__item__remove\"\n title=\"{{@root.strings.remove}}\"\n >\n <hawksearch-icon name=\"cross\" size=\"0.9em\"></hawksearch-icon>\n </a>\n </span>\n {{/each}}\n</div>\n</code></pre>\n"},"parentId":1,"hierarchy":[{"name":"BaseComponent<SelectedFacetsComponentConfig, SelectedFacet[], SelectedFacetsComponentModel>","linkId":"6","children":[{"name":"SelectedFacetsComponent","isTarget":true,"linkId":"36322"}]}]}