Interface ErrorDialog

Allows users to customize the error dialog.

The ErrorDialog is the menu that shows up when something goes wrong loading.

interface ErrorDialog {
    get message(): string;
    set message(message: string): void;
    get messageColor(): string;
    set messageColor(messageColor: string): void;
    get onCancel(): () => void;
    set onCancel(onCancel: () => void): void;
    get onTryAgain(): () => void;
    set onTryAgain(onTryAgain: () => void): void;
}

Accessors

message messageColor onCancel onTryAgain

Accessors

message

  • get message(): string

  • Returns string

    Message to show the user, representing whatever went wrong.

    Default

    ""
  • set message(message: string): void

  • Parameters

    • message: string

      Message to show the user, representing whatever went wrong.

    Returns void

messageColor

  • get messageColor(): string

  • Returns string

    CSS used to control the color of the error message.

    Default

    "red"
  • set messageColor(messageColor: string): void

  • Parameters

    • messageColor: string

      CSS used to control the color of the error message.

    Returns void

onCancel

  • get onCancel(): () => void

  • Returns () => void

    Function called if user clicks the cancel button.

    Cancel button will only be visible if this property is set.

    Default

    null
  • set onCancel(onCancel: () => void): void

  • Parameters

    • onCancel: () => void

      Function called if user clicks the cancel button.

      Cancel button will only be visible if this property is set.

    Returns void

onTryAgain

  • get onTryAgain(): () => void

  • Returns () => void

    Function called if user clicks the try again button.

    Try again button will only be visible if this property is set.

    Default

    null
  • set onTryAgain(onTryAgain: () => void): void

  • Parameters

    • onTryAgain: () => void

      Function called if user clicks the try again button.

      Try again button will only be visible if this property is set.

    Returns void

Settings

Member Visibility

On This Page

Accessors