Class AbstractMultiScreenComponent<T>`Abstract`

Type Parameters

T extends MultiScreenScreen = MultiScreenScreen

Hierarchy

AbstractMultiScreenComponent
- DesktopSideScreenUI
- DrawerUI

Implements

IUIElement<T[]>

Index

Constructors

Properties

multiScreenUI registeredScreens root

Accessors

currentScreen element previousScreen rootClassNames

Methods

buildInitialHtml destroy goBack has hide isOpen onSizeUpdate registerScreen reset setData show toggle

Constructors

constructor

new AbstractMultiScreenComponent<T>(): AbstractMultiScreenComponent<T>
Type Parameters
- T extends MultiScreenScreen = MultiScreenScreen
Returns AbstractMultiScreenComponent<T>
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:16

Properties

`Protected` multiScreenUI

multiScreenUI: MultiScreenUI

`Protected` registeredScreens

registeredScreens: Map<string, T> = ...

`Protected` root

root: HTMLElement

Accessors

currentScreen

get currentScreen(): string
Returns string
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:20

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.element
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:28

previousScreen

get previousScreen(): string
Returns string
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:24

`Abstract` rootClassNames

get rootClassNames(): string[]
Returns string[]
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:32

Methods

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.buildInitialHtml
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:38

destroy

destroy(): void
Destroy the UI entirely and eliminate all memory

Returns void
Implementation of IUIElement.destroy
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:71

goBack

goBack(): void
Returns void
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:80

has

has(screen: string): boolean
Parameters
- screen: string
Returns boolean
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:34

`Abstract` hide

hide(): void
Returns void
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:60

`Abstract` isOpen

isOpen(): boolean
Returns boolean
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:64

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Automatically called whenever the size updates
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIElement.onSizeUpdate
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:52

registerScreen

registerScreen(screen: T): void
Parameters
- screen: T
Returns void
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:66

reset

reset(): void
Reset the UI to be re-used

Returns void
Implementation of IUIElement.reset
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:75

setData

setData(data: T[]): void
Parameters
- data: T[]
Returns void
Implementation of IUIElement.setData
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:43

`Abstract` show

show(screen: string): void
Parameters
- screen: string
Returns void
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:62

`Abstract` toggle

toggle(screen: string): boolean
Opens/Closes the drawer for a particular screen
Parameters
- screen: string
  
  the registered screen name to open
Returns boolean
- Defined in js/modularconfig/ui/AbstractMultiScreenComponent.tsx:58

Generated using TypeDoc