Class RootComponent

The root component to host the rest of the components. There is not limitation right no but ideally there should only be one of these on a page.

Hierarchy (View Summary)

Component
- RootComponent

Index

Constructors

constructor

new RootComponent(window: Window, options: RootComponentOptions): RootComponent
Parameters
- window: Window
- options: RootComponentOptions
Returns RootComponent
Overrides Component.constructor
- Defined in core/rootComponent.ts:13

Properties

id

id: string

isInitialized

isInitialized: boolean

isMounted

isMounted: boolean

`Protected`options

options: ComponentOptions

`Protected`resourcesLoaded

resourcesLoaded: boolean

`Protected`rootElement

rootElement: HTMLElement | null

`Protected`window

window: Window | null

Methods

addChild

addChild(options: ChildComponentOptions): Promise<string>
Add a child component.
Parameters
- options: ChildComponentOptions
  Child component options.
Returns Promise<string>
- Defined in core/rootComponent.ts:67

`Protected`callErrorHandler

callErrorHandler(e: Error): void
Call the global error handler.
Parameters
- e: Error
  The error object
Returns void
Inherited from Component.callErrorHandler
- Defined in core/component.ts:141

`Protected`callHandler

callHandler(type: ComponentEventType, data?: unknown): void
Call a specific event handler.
Parameters
- type: ComponentEventType
  The type of handler to call.
- Optionaldata: unknown
Returns void
Inherited from Component.callHandler
- Defined in core/component.ts:160

dispose

dispose(): Promise<void>
Method invoked to dispose of the component.

Returns Promise<void>
Inherited from Component.dispose
- Defined in core/component.ts:235

`Protected`disposeCore

disposeCore(): Promise<void>
Core dispose function. Any component derived should override this to add clean-up after itself.

Returns Promise<void>
Inherited from Component.disposeCore
- Defined in core/component.ts:132

getChild

getChild(id: string | null): Component | null
Get the child with the given identifier.
Parameters
- id: string | null
  The child identifier.
Returns Component | null
- Defined in core/rootComponent.ts:89

`Protected`getDocument

getDocument(): Document
Get the document reference.

Returns Document
Inherited from Component.getDocument
- Defined in core/component.ts:106

`Protected`getOptions

getOptions(): ComponentOptions
Get the options data.

Returns ComponentOptions
Inherited from Component.getOptions
- Defined in core/component.ts:92

`Protected`getWindow

getWindow(): Window
Get the window reference.

Returns Window
Inherited from Component.getWindow
- Defined in core/component.ts:99

initialize

initialize(): Promise<Component>
Method invoked to initialize the component. It should create the root element and any base dependencies.

Returns Promise<Component>
Inherited from Component.initialize
- Defined in core/component.ts:195

`Protected`initializeCore

initializeCore(): Promise<void>
Core initialization function. Any component derived should override this to add extra functionality.

Returns Promise<void>
Inherited from Component.initializeCore
- Defined in core/component.ts:114

`Protected`loadResources

loadResources(): Promise<void>
Load the resources required by the component.

Returns Promise<void>
Inherited from Component.loadResources
- Defined in core/component.ts:74

`Protected`log

log(message?: unknown, ...optionalParams: unknown[]): void
Logging method.
Parameters
- Optionalmessage: unknown
  The message.
- ...optionalParams: unknown[]
  Optional parameters.
Returns void
Inherited from Component.log
- Defined in core/component.ts:185

mount

mount(): Promise<Component>
Method invoked to mount the actual content of the component.

Returns Promise<Component>
Inherited from Component.mount
- Defined in core/component.ts:214

`Protected`mountCore

mountCore(): Promise<void>
@@inheritdoc

Returns Promise<void>
Overrides Component.mountCore
- Defined in core/rootComponent.ts:57

removeChild

removeChild(id: string): Promise<void>
Remove a child component.
Parameters
- id: string
  The child component identifier.
Returns Promise<void>
- Defined in core/rootComponent.ts:98