Class Modal

The Modal component for building alert and confirm dialog.

Hierarchy

Modal

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Modal(options?: ModalOptions): Modal

- Defined in scripts/Modal.tsx:11
Parameters
- Optional options: ModalOptions
Returns Modal

Properties

Private closeListeners

closeListeners: Array<function> = []

finalOptions

finalOptions: ModalOptions

Private ref

ref: HTMLElement | undefined

Static Private containerRef

containerRef: HTMLElement | null = null

Methods

addCloseListener

addCloseListener(fn: function): void

- Defined in scripts/Modal.tsx:60
Parameters
- fn: function
  - - (sender: Modal): void
    - Parameters
      - sender: Modal
      Returns void
Returns void

close

close(event?: any): void

- Defined in scripts/Modal.tsx:41
Closes the Modal instance.

Parameters
- Optional event: any
  
  The close event
Returns void

Private removeElement

removeElement(): void

- Defined in scripts/Modal.tsx:64
Returns void

render

render(options?: ModalOptions): void

- Defined in scripts/Modal.tsx:26
Renders a Modal instance with options.

Parameters
- Optional options: ModalOptions
  
  The modal options, see the ModalOptions interface
Returns void

Private renderButtons

renderButtons(buttons: ModalButton[]): HTMLElement

- Defined in scripts/Modal.tsx:187
Parameters
- buttons: ModalButton[]
Returns HTMLElement

Private renderElement

renderElement(): HTMLElement

- Defined in scripts/Modal.tsx:82
Returns HTMLElement

Private renderFooter

renderFooter(options: ModalOptions): HTMLElement

- Defined in scripts/Modal.tsx:168
Parameters
- options: ModalOptions
Returns HTMLElement

Private renderOverlay

renderOverlay(): HTMLElement

- Defined in scripts/Modal.tsx:75
Returns HTMLElement

Private renderTip

renderTip(tip: string): HTMLElement

- Defined in scripts/Modal.tsx:180
Parameters
- tip: string
Returns HTMLElement

Generated by BNDY-NET