Interface CustomPanelConfigOptions

Options that change how the custom panel looks.

interface CustomPanelConfigOptions {
    disableAnimation?: boolean;
    disableDefaultCloseAction?: boolean;
    hideBackButton?: boolean;
    hideCloseAndRestartButton?: boolean;
    hideCloseButton?: boolean;
    hidePanelHeader?: boolean;
    onClickBack?: () => void;
    onClickClose?: () => void;
    onClickCloseAndRestart?: () => void;
    onClickRestart?: () => void;
    title?: string;
}

Hierarchy

  • BasePanelConfigOptions
    • CustomPanelConfigOptions

Properties

disableAnimation? disableDefaultCloseAction? hideBackButton? hideCloseAndRestartButton? hideCloseButton? hidePanelHeader? onClickBack? onClickClose? onClickCloseAndRestart? onClickRestart? title?

Properties

OptionaldisableAnimation

disableAnimation?: boolean

Determines if the panel open/close animation should be turned off.

OptionaldisableDefaultCloseAction

disableDefaultCloseAction?: boolean

Disables the default action that is taken when the close or close-and-restart buttons are clicked. The default action closes web chat and disabling this will cause the button to not do anything. You can override the button behavior by using the onClickClose or onClickCloseAndRestart callback.

OptionalhideBackButton

hideBackButton?: boolean

Indicates if the back button in the custom panel should be hidden.

OptionalhideCloseAndRestartButton

hideCloseAndRestartButton?: boolean

Indicates if the close-and-restart (X) button in the custom panel should be hidden. This value only applies if the close-and-restart button is enabled.

OptionalhideCloseButton

hideCloseButton?: boolean

Indicates if the close button in the custom panel should be hidden.

OptionalhidePanelHeader

hidePanelHeader?: boolean

Indicates if the panel header should be hidden.

OptionalonClickBack

onClickBack?: () => void

This callback is called when the back button is clicked.

OptionalonClickClose

onClickClose?: () => void

This callback is called when the close button is clicked. This is called even if disableDefaultCloseAction is set to true.

OptionalonClickCloseAndRestart

onClickCloseAndRestart?: () => void

This callback is called when the close-and-restart button is clicked. This is called even if disableDefaultCloseAction is set to true.

OptionalonClickRestart

onClickRestart?: () => void

Called when the restart button is clicked.

Optionaltitle

title?: string

The panel title which is left blank by default.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR