Class BaseComponent<TConfig, TData, TModel>`Abstract`

Type Parameters

TConfig extends BaseComponentConfig

Component configuration
TData

Component data
TModel extends BaseComponentModel

Data bound to Handlebars template

Index

Properties

configOverride? contentModel? data? handlebars

Accessors

configuration rootElement

Methods

bindChildElements interpolate onRender registerHelpers render renderContent triggerEvent

Properties

`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?: TData

The data bound to the component.

`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

bindChildElements(): void
After the component is rendered, this method is called to bind any child components.

Returns void

`Protected` interpolate

interpolate(template, values): string
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

onRender(): void
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

registerHelpers(): void
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

render(): void
Binds contentModel to the Handlebars template and renders the resulting HTML content.

Returns void

`Protected` renderContent

renderContent(): boolean
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

triggerEvent<T>(name, data): void
Type Parameters
- T
Parameters
- name: string
- data: T
Returns void