Class ModalUI

Used by the AppController to bring up several screens, all app edits should be done there

Hierarchy

ModalUI

Implements

IUIElement<ModalOptions>

Index

Constructors

Properties

closeButton closeOnBackgroundClick header modal modalContent root

Accessors

Methods

buildInitialHtml destroy hide isOpen onSizeUpdate reset setData show

Constructors

constructor

new ModalUI(options: ModalOptions): ModalUI
Parameters
- options: ModalOptions
Returns ModalUI
- Defined in js/modularconfig/ui/ModalUI.tsx:22

Properties

`Protected` closeButton

closeButton: HTMLElement

`Protected` closeOnBackgroundClick

closeOnBackgroundClick: boolean

`Protected` header

header: HTMLElement

`Protected` modal

modal: MxtModal

`Protected` modalContent

modalContent: HTMLElement

`Protected` root

root: HTMLElement

Accessors

element

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

Methods

buildInitialHtml

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

destroy

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

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

hide

hide(hideImmediate: boolean): void
Parameters
- hideImmediate: boolean
Returns void
- Defined in js/modularconfig/ui/ModalUI.tsx:92

isOpen

isOpen(): boolean
Returns boolean
- Defined in js/modularconfig/ui/ModalUI.tsx:80

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/ModalUI.tsx:74

reset

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

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

setData

setData(data: ModalOptions): void
Parameters
- data: ModalOptions
Returns void
Implementation of IUIElement.setData
- Defined in js/modularconfig/ui/ModalUI.tsx:56

show

show(content: HTMLElement): void
Parameters
- content: HTMLElement
Returns void
- Defined in js/modularconfig/ui/ModalUI.tsx:84

Generated using TypeDoc