Type alias OverlayConfig

OverlayConfig: {
    dissmisable?: boolean;
    id?: string;
    image?: string;
    text?: string;
    title: string;
}

Configuration for Overlay.show

Type declaration

  • Optional dissmisable?: boolean

    if the user can hide the overlay by clicking

    Default

    true
    
  • Optional id?: string

    unique identifier to use with Overlay.hide and Overlay.isVisible

  • Optional image?: string

    SVG image/icon displayed above the text

  • Optional text?: string

    secondary message

  • title: string

    main message

Generated using TypeDoc