Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DialogManager

Class to define the dialog manager component

Hierarchy

  • DialogManager

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates an instance of DialogManager.

    Returns DialogManager

Properties

destroyTimeout

destroyTimeout: number

A number millisecond to define the time to destroy the dialog list components

type

{number}

default

150

dialogs

dialogs: RootSiblings[]

A list of dialogs to show

type

{RootSiblings[]}

Accessors

currentDialog

  • get currentDialog(): RootSiblings

  • Method to get the current dialog

    readonly
    type

    {RootSiblings}

    Returns RootSiblings

Methods

add

  • add(props: IDialogProps, callback?: undefined | function): void

  • Method to add a new dialog to the list

    Parameters

    • props: IDialogProps

      A object of the DialogProps

    • Optional callback: undefined | function

    Returns void

destroy

  • destroy(): void

  • Method to destroy a dialog of the list

    Returns void

dismiss

  • dismiss(callback?: undefined | function): void

  • Method to dismiss the dialog of the list

    Parameters

    • Optional callback: undefined | function

    Returns void

dismissAll

  • dismissAll(callback?: undefined | function): void

  • Method to dismiss all the dialogs of the list

    Parameters

    • Optional callback: undefined | function

    Returns void

onDialogDismissed

  • onDialogDismissed(onDismiss?: undefined | function): void

  • Method that fire when the a dialog of the list is dismissed

    Parameters

    • Optional onDismiss: undefined | function

    Returns void

show

  • show(props: IDialogProps, callback?: undefined | function): void

  • Method to show the dialog of the list

    Parameters

    • props: IDialogProps

      An object of the DialogProps

    • Optional callback: undefined | function

    Returns void

showOne

  • showOne(props: IDialogProps, callback?: undefined | function): void

  • Method to show the dialog one time of the list

    Parameters

    • props: IDialogProps

      An object of the DialogProps

    • Optional callback: undefined | function

    Returns void

update

  • update(props: IDialogProps, callback?: undefined | function): void

  • Method to update a dialog of the list

    Parameters

    • props: IDialogProps

      An object of the DialogProps

    • Optional callback: undefined | function

    Returns void

Generated using TypeDoc