Component
Defined in: publish.d.ts:277
Extended by
Constructors
new Component()
new Component():
Component
Returns
Methods
addChild()
addChild<
T
>(component
):T
Defined in: publish.d.ts:305
Adds a child component, loading it if this component is loaded
Type Parameters
• T extends Component
Parameters
component
T
Returns
T
load()
load():
void
Defined in: publish.d.ts:283
Load this component and its children
Returns
void
onload()
onload():
void
Defined in: publish.d.ts:289
Override this to load your component
Returns
void
onunload()
onunload():
void
Defined in: publish.d.ts:300
Override this to unload your component
Returns
void
register()
register(
cb
):void
Defined in: publish.d.ts:315
Registers a callback to be called when unloading
Parameters
cb
() => any
Returns
void
registerDomEvent()
Call Signature
registerDomEvent<
K
>(el
,type
,callback
,options
?):void
Defined in: publish.d.ts:325
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof WindowEventMap
Parameters
el
type
K
callback
(this
, ev
) => any
options?
boolean
| AddEventListenerOptions
Returns
void
Call Signature
registerDomEvent<
K
>(el
,type
,callback
,options
?):void
Defined in: publish.d.ts:330
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof DocumentEventMap
Parameters
el
type
K
callback
(this
, ev
) => any
options?
boolean
| AddEventListenerOptions
Returns
void
Call Signature
registerDomEvent<
K
>(el
,type
,callback
,options
?):void
Defined in: publish.d.ts:335
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof HTMLElementEventMap
Parameters
el
type
K
callback
(this
, ev
) => any
options?
boolean
| AddEventListenerOptions
Returns
void
registerEvent()
registerEvent(
eventRef
):void
Defined in: publish.d.ts:320
Registers an event to be detached when unloading
Parameters
eventRef
Returns
void
registerInterval()
registerInterval(
id
):number
Defined in: publish.d.ts:342
Registers an interval (from setInterval) to be cancelled when unloading Use window#setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API
Parameters
id
number
Returns
number
removeChild()
removeChild<
T
>(component
):T
Defined in: publish.d.ts:310
Removes a child component, unloading it
Type Parameters
• T extends Component
Parameters
component
T
Returns
T
unload()
unload():
void
Defined in: publish.d.ts:294
Unload this component and its children
Returns
void