Class BubbleContentComponent

The Bubble Content component shows trigger info in a tooltip ("?") bubble.

Hierarchy

BaseComponent<BubbleContentComponentConfig, Trigger, BubbleContentComponentModel>
- BubbleContentComponent

Index

Properties

bindFromEvent componentName configOverride? contentModel? data? defaultHtml handlebars

Accessors

configuration rootElement useCustomStyle

Methods

bindChildElements getContentModel interpolate onRender registerHelpers render renderContent triggerEvent

Properties

`Protected` bindFromEvent

bindFromEvent: boolean = false

`Protected` componentName

componentName: keyof HawkSearchComponents = 'bubble-content'

`Optional` configOverride

configOverride?: BubbleContentComponentConfig

Optional instance-level configuration to override the global configuration

`Protected` `Optional` contentModel

contentModel?: BubbleContentComponentModel

The data bound to the Handlebars template.

`Optional` data

data?: Trigger

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

Inherited from BaseComponent.configuration

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

Inherited from BaseComponent.rootElement

`Protected` useCustomStyle

get useCustomStyle(): boolean
Returns boolean

Inherited from BaseComponent.useCustomStyle

Methods

`Protected` bindChildElements

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

Returns void

Inherited from BaseComponent.bindChildElements

`Protected` getContentModel

getContentModel(): BubbleContentComponentModel
Builds the content model for the template.

Returns BubbleContentComponentModel

Overrides BaseComponent.getContentModel

`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.

Inherited from BaseComponent.interpolate

`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

Inherited from BaseComponent.onRender

`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

Inherited from BaseComponent.registerHelpers

render

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

Returns void

Inherited from BaseComponent.render

`Protected` renderContent

renderContent(): boolean
Determines if the component should render. We render when there is valid data (bubleData or similar).

Returns boolean

Overrides BaseComponent.renderContent

`Protected` triggerEvent

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

Inherited from BaseComponent.triggerEvent