# Interface: upcomingLiveOverlayComponent
# Hierarchy
-
↳
upcomingLiveOverlayComponent
# Table of contents
# Properties
# Methods
# Properties
# el
• el: HTMLElement
Compiled Component's element from passed domString
parameter.
# Inherited from
# wrapperEl
• wrapperEl: HTMLElement
Component's wrapper element.
# Inherited from
# Methods
# disable
▸ disable(): void
# Returns
void
# Inherited from
# enable
▸ enable(): void
# Returns
void
# Inherited from
# getValue
▸ getValue(dataAttr
): string
Gets the value of innerHtml
from element which matched by @param dataAttr.
# Parameters
Name | Type | Description |
---|---|---|
dataAttr | string | the name of the data attribute to match the component's element. <div data-test-value>Test value</div> component.getValue("test-value") // returns "Test value" |
# Returns
string
# Inherited from
# hide
▸ hide(): void
Hide live event component;
# Returns
void
# Overrides
# isVisible
▸ isVisible(): boolean
Returns true
if component is visible, false
otherwise.
# Returns
boolean
# Inherited from
# onClick
▸ onClick(event?
): void
On component click handler function
# Parameters
Name | Type |
---|---|
event? | Event |
# Returns
void
# Inherited from
# setValue
▸ setValue(dataAttr
, value
): void
Replaces the value of innerHtml
from element which matched by @param dataAttr.
# Parameters
Name | Type | Description |
---|---|---|
dataAttr | string | the name of the data attribute to match the component's element. <div data-test-value>Test value</div> component.setValue("test-value", "Replaced") // Will replace the text in div to "Replaced" text. |
value | any | - |
# Returns
void
# Inherited from
# show
▸ show(): void
Shows live event component;
# Returns
void
# Overrides
# toggle
▸ toggle(): void
Toggles live event component;
# Returns
void
# updateDom
▸ updateDom(domString
): void
Updates components DOM with provided domString
parameter.
# Parameters
Name | Type |
---|---|
domString | string |
# Returns
void