Class BaseFacetComponent<TConfig, TModel>Abstract

The Base Facet component is inherited by all facet type copmonents.

Event-Binding Attributes

The following attributes are common to all facet type components. Individual facet types may support additional attribute bindings.

Name Value
hawksearch-facet-value string (if applicable)

When a checkbox input element with this attribute is checked or unchecked, the value of that element will be added or removed from the search request as appropriate. For non-input elements, the attribute value will be used instead of a form element value.

Name Value
hawksearch-facet-value-exclude string

When an element with this attribute is clicked, search results with the corresponding attribute value will be excluded from search results.

Name Value
hawksearch-facet-value-include string

When an element with this attribute is clicked, search results with the corresponding attribute value will no longer be excluded from search results.

Note: Elements with this attribute value should only be displayed for facet values that are excluded.

Name Value
hawksearch-facet-value-toggle

When an element with this attribute is clicked, child facet values will be displayed or hidden as appropriate.

Note: This attribute should only be used for facets that support nested values.

Type Parameters

Hierarchy

Properties

bindFromEvent configOverride? contentModel? data? handlebars state

Accessors

configuration rootElement

Methods

bindChildElements interpolate onRender registerHelpers render renderContent triggerEvent

Properties

Protected bindFromEvent

bindFromEvent: boolean = false

Optional configOverride

configOverride?: TConfig

Optional instance-level configuration to override the global configuration

Protected Optional contentModel

contentModel?: TModel

The data bound to the Handlebars template.

Optional data

data?: Facet

The data bound to the component.

Protected handlebars

handlebars: typeof Handlebars = HawkSearch.handlebars

The Handlebars reference shared by all HawkSearch components.

state

state: FacetState

Accessors

Protected configuration

  • get configuration(): undefined | TConfig

  • The optional configuration object for this component.

    Returns undefined | TConfig

rootElement

  • get rootElement(): ParentNode

  • The root element which should be used for querying any child elements. This resolves to this.shadowRoot if the Shadow DOM is enabled, otherwise this.

    Returns ParentNode

Methods

Protected bindChildElements

  • After the component is rendered, this method is called to bind any child components.

    Returns void

Protected interpolate

  • Replaces placeholders in a given string with values from a data object.

    Parameters

    • template: string

      The template string.

    • values: Record<string, string>

      The object containing properties which will be bound to template.

    Returns string

    The template string with all placeholders replaced by the values specified in values.

Protected onRender

  • After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.

    Returns void

Protected registerHelpers

  • Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see Custom Helpers.

    Returns void

render

Protected renderContent

  • Determines whether the data meets the necessary conditions to perform data binding and render content.

    Returns boolean

    Whether the component should be rendered. If false, the component will have empty contents and be set to display: none;.

Protected triggerEvent

  • Type Parameters

    • T

    Parameters

    • name: string
    • data: T

    Returns void

Settings

Member Visibility

Theme

On This Page