Class RatingComponent

The Rating component is used to display a visual representation of ratings for a particular product.

Tag

The tag for this component is <hawksearch-rating>.

Attributes

Name Type Default Value Required
rating number Yes

These attributes are used to position the tooltip based on the size and scroll position of the active window. The hawksearch-tooltip attribute should be present on an element containing both the element the tooltip is attached to (to display on hover) and the element containing the tooltip content, which should have a hawksearch-tooltip-content attribute.

Handlebars Helpers

Name Rating Star Number
ratingIcon number number

This helper function returns the icon name to display for a given rating and star number (1-5)

Default Template

The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.

<div class="rating" title="{{rating}}">
    <hawksearch-icon name="{{ratingIcon rating 0}}" class="rating__icon"></hawksearch-icon>
    <hawksearch-icon name="{{ratingIcon rating 1}}" class="rating__icon"></hawksearch-icon>
    <hawksearch-icon name="{{ratingIcon rating 2}}" class="rating__icon"></hawksearch-icon>
    <hawksearch-icon name="{{ratingIcon rating 3}}" class="rating__icon"></hawksearch-icon>
    <hawksearch-icon name="{{ratingIcon rating 4}}" class="rating__icon"></hawksearch-icon>
</div>

Hierarchy

Properties

bindFromEvent componentName configOverride? contentModel? data? defaultHtml handlebars

Accessors

configuration rootElement

Methods

bindChildElements getContentModel interpolate onRender registerHelpers render renderContent triggerEvent

Properties

Protected bindFromEvent

bindFromEvent: boolean = false

Protected componentName

componentName: keyof HawkSearchComponents = 'rating'

Optional configOverride

configOverride?: RatingComponentConfig

Optional instance-level configuration to override the global configuration

Protected Optional contentModel

contentModel?: RatingComponentModel

The data bound to the Handlebars template.

Optional data

data?: number

The data bound to the component.

Protected defaultHtml

defaultHtml: string = defaultHtml

Protected handlebars

handlebars: typeof Handlebars = HawkSearch.handlebars

The Handlebars reference shared by all HawkSearch components.

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 getContentModel

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