HotComponent

hotstaq / Modules / HotComponent

Class: HotComponent

A component to preprocess.

Implements

• IHotComponent

Table of contents

Constructors

• constructor

Properties

• api
• elementOptions
• events
• htmlElement
• name
• processor
• tag
• type
• value

Methods

• click
• handleAttributes
• onCreated
• output

Constructors

constructor

• new HotComponent(copy, api?)

Parameters

Name	Type	Default value
copy	HotStaq | IHotComponent	undefined
api	HotAPI	null

Defined in

HotComponent.ts:101

Properties

api

• api: HotAPI

The connected API.

Implementation of

IHotComponent.api

Defined in

HotComponent.ts:77

---

elementOptions

• elementOptions: ElementDefinitionOptions

The options to include with registering this component.

Implementation of

IHotComponent.elementOptions

Defined in

HotComponent.ts:81

---

events

• events: Object

The events to trigger.

Index signature

▪ [name: string]: { func: Function ; options: any ; type: string }

Implementation of

IHotComponent.events

Defined in

HotComponent.ts:93

---

htmlElement

• htmlElement: HTMLElement

The associated HTMLElement.

Implementation of

IHotComponent.htmlElement

Defined in

HotComponent.ts:65

---

name

• name: string

The name of the component.

Implementation of

IHotComponent.name

Defined in

HotComponent.ts:69

---

processor

• processor: HotStaq

The processor to use.

Implementation of

IHotComponent.processor

Defined in

HotComponent.ts:61

---

tag

• tag: string

The name of the tag.

Implementation of

IHotComponent.tag

Defined in

HotComponent.ts:73

---

type

• type: string

The type of component.

Implementation of

IHotComponent.type

Defined in

HotComponent.ts:85

---

value

• value: any

The value of the component.

Implementation of

IHotComponent.value

Defined in

HotComponent.ts:89

Methods

click

▸ Abstract click(): Promise<void>

Handle a click event.

Returns

Promise<void>

Defined in

HotComponent.ts:152

---

handleAttributes

▸ Optional handleAttributes(attributes): Promise<void>

Handle the attributes manually.

Parameters

Name	Type
attributes	NamedNodeMap

Returns

Promise<void>

Defined in

HotComponent.ts:147

---

onCreated

▸ onCreated(element): Promise<any>

Event that's called when this component is created. This is called before output is called. Right after this is called, the attributes from the HTMLElement will be processed. If the functionality of the attributes processing need to be overwritten, use the handleAttributes method to handle them.

Parameters

Name	Type
element	HTMLElement

Returns

Promise<any>

Defined in

HotComponent.ts:139

---

output

▸ Abstract output(): Promise<string>

Output the component.

Returns

Promise<string>

Defined in

HotComponent.ts:157