Class RenderUI

Hierarchy

RenderUI

Implements

IUIElement<ModConfigUIUpdateData>

Index

Constructors

Properties

customIcons delegate loading placeUI root

Accessors

Methods

buildInitialHtml createLoadingUI createPlaceUI destroy hideLoading onSizeUpdate reset setData showLoading

Constructors

constructor

new RenderUI(delegate: IModularConfigPlaceDelegate, customIcons: MxtModularConfigPlacingIcons): RenderUI
Parameters
- delegate: IModularConfigPlaceDelegate
- customIcons: MxtModularConfigPlacingIcons
Returns RenderUI
- Defined in js/modularconfig/ui/RenderUI.tsx:26

Properties

customIcons

customIcons: MxtModularConfigPlacingIcons

delegate

delegate: IModularConfigPlaceDelegate

`Protected` loading

loading: ILoadingUI

`Protected` placeUI

placeUI: ModularConfigPlaceUI

`Protected` root

root: HTMLElement

Accessors

element

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

Methods

buildInitialHtml

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

`Protected` createLoadingUI

createLoadingUI(): ILoadingUI
Returns ILoadingUI
- Defined in js/modularconfig/ui/RenderUI.tsx:77

createPlaceUI

createPlaceUI(): void
Returns void
- Defined in js/modularconfig/ui/RenderUI.tsx:49

destroy

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

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

hideLoading

hideLoading(): void
Returns void
- Defined in js/modularconfig/ui/RenderUI.tsx:58

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/RenderUI.tsx:88

reset

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

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

setData

setData(data: ModConfigUIUpdateData): void
Parameters
- data: ModConfigUIUpdateData
Returns void
Implementation of IUIElement.setData
- Defined in js/modularconfig/ui/RenderUI.tsx:85

showLoading

showLoading(message?: string, atTop?: boolean): void
Parameters
- Optional message: string
- atTop: boolean = false
Returns void
- Defined in js/modularconfig/ui/RenderUI.tsx:53

Generated using TypeDoc