Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModalConfig

A configuration definition object. Instruction for how to show a modal.

Hierarchy

  • ModalConfig

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ModalConfig(size?: string, isBlocking?: boolean, keyboard?: Array<number> | number): ModalConfig

  • Parameters

    • Default value size: string = null
    • Default value isBlocking: boolean = null
    • Default value keyboard: Array<number> | number = undefined

    Returns ModalConfig

Properties

isBlocking

isBlocking: boolean

Describes if the modal is blocking modal. A Blocking modal is not closable by clicking outside of the modal window. Defaults to false.

keyboard

keyboard: Array<number> | number

Keyboard value/s that close the modal. Accepts either a single numeric value or an array of numeric values. A modal closed by a keyboard stroke will result in a 'reject' notification from the promise. Defaults to 27, set null implicitly to disable.

size

size: string

Size of the modal. 'lg' or 'sm' only. NOTE: No validation. Default to 'lg'

Methods

Static makeValid

  • Makes a ModalConfig instance valdud.

    Parameters

    Returns ModalConfig

    The same config instance sent.

Generated using TypeDoc